Adres środowiska testowego: https://apisandbox.aligato.pl
Adres api: https://apisandbox.aligato.pl/api/server.php?wsdl
Adres generatora klucza: https://apisandbox.aligato.pl/api.html

API.doLoginEnc
Zalogowanie się i pobranie identyfikatora sesji
userLogin | string
wymagany

Nazwa użytkownika

userHashPassword | string
wymagany

Zahashowane hasło

webapiKey | string
wymagany

Klucz API

sessionHandlePart | string

ID sesji

userHashPassword | string

Zahashowane hasło

webapiKey | string

Klucz API

    object(stdClass)#2 (4) {
  ["sessionHandlePart"]=>
  string(40) "694cb441529c451aedcba100ef1f38328859125a"
  ["userId"]=>
  int(1)
  ["expires"]=>
  int(1528808248)
  ["serverTime"]=>
  int(1528804648)
}

Nazwa użytkownika

Zahashowane hasło

Klucz API

Orientacyjna struktura wywołania metody:
<?php
$client = new SoapClient('http://api.aligato.pl/server.php?wsdl');
$doLoginEncRequest = [
    'userLogin' => 'apiUser',
    'userHashPassword' => 'apiPassword',
    'webapiKey' => '6ee49151-32af-4664-a704-44725c39b5f5'
];
$response = $client->__soapCall('API.doLoginEnc', $doLoginEncRequest);
var_dump($response);

// Dane zwrócone
/*
object(stdClass)#2 (4) {
  ["sessionHandlePart"]=>
  string(40) "694cb441529c451aedcba100ef1f38328859125a"
  ["userId"]=>
  int(1)
  ["expires"]=>
  int(1528808248)
  ["serverTime"]=>
  int(1528804648)
}
*/
API.doGetApiInfo
Pobranie informacji o API
sessionHandlePart | string
wymagany

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

version | float

Wersja API

serverTime | float

Timestamp (czas serwera)

    object(stdClass)#2 (2) {
  ["version"]=>
  float(0.001)
  ["serverTime"]=>
  float(1528804325)
}

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

Orientacyjna struktura wywołania metody:
<?php
$client = new SoapClient('http://api.aligato.pl/server.php?wsdl');
$doGetApiInfoRequest = [
    'sessionHandlePart' => 'cca2fdab811a780beab44e5f1867952b'
];
$response = $client->__soapCall('API.doGetApiInfo', $doGetApiInfoRequest);
var_dump($response);

// Dane zwrócone
/*
object(stdClass)#2 (2) {
  ["version"]=>
  float(0.001)
  ["serverTime"]=>
  float(1528804325)
}
*/
API.doGetSystemTime
Pobranie czasu serwera
sessionHandlePart | string
wymagany

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

serverTime | float

Timestamp (czas serwera)

    object(stdClass)#2 (1) {
  ["serverTime"]=>
  float(1528804022)
}

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

Orientacyjna struktura wywołania metody:
<?php
$client = new SoapClient('http://api.aligato.pl/server.php?wsdl');
$doGetSystemTimeRequest = [
    'sessionHandlePart' => 'cca2fdab811a780beab44e5f1867952b'
];
$response = $client->__soapCall('API.doGetSystemTime', $doGetSystemTimeRequest);
var_dump($response);

// Dane zwrócone
/*
object(stdClass)#2 (1) {
  ["serverTime"]=>
  float(1528804022)
}
*/
API.doGetCategories
Pobranie listy kategorii
sessionHandlePart | string
wymagany

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

categories | array

Tablica z kategoriami

  1. categoryId | integer | ID Kategorii
  2. categoryName | string | Nazwa Kategorii
    object(stdClass)#2 (1) {
  ["categories"]=>
  array(2) {
    [0]=>
    object(stdClass)#3 (2) {
      ["categoryId"]=>
      string(1) "5"
      ["categoryName"]=>
      string(11) "Elektronika"
    }
    [1]=>
    object(stdClass)#4 (2) {
      ["categoryId"]=>
      string(1) "6"
      ["categoryName"]=>
      string(12) "Moda i uroda"
    }
  }
}

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

Orientacyjna struktura wywołania metody:
<?php
$client = new SoapClient('http://api.aligato.pl/server.php?wsdl');
$doGetCategoriesRequest = [
    'sessionHandlePart' => 'cca2fdab811a780beab44e5f1867952b'
];
$response = $client->__soapCall('API.doGetCategories', $doGetCategoriesRequest);
var_dump($response);

// Dane zwrócone
/*
object(stdClass)#2 (1) {
  ["categories"]=>
  array(2) {
    [0]=>
    object(stdClass)#3 (2) {
      ["categoryId"]=>
      string(1) "5"
      ["categoryName"]=>
      string(11) "Elektronika"
    }
    [1]=>
    object(stdClass)#4 (2) {
      ["categoryId"]=>
      string(1) "6"
      ["categoryName"]=>
      string(12) "Moda i uroda"
    }
  }
}
*/
API.doGetCountries
Pobranie listy krajów
sessionHandlePart | string
wymagany

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

countries | array

Tablica z krajami

  1. countryId | integer | ID kraju
  2. countryName | string | Nazwa kraju
    array(2) {
  [0]=>
  object(stdClass)#2 (2) {
    ["countryName"]=>
    string(11) "Afghanistan"
    ["countryId"]=>
    string(3) "501"
  }
  [1]=>
  object(stdClass)#3 (2) {
    ["countryName"]=>
    string(7) "Albania"
    ["countryId"]=>
    string(3) "184"
  }

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

Orientacyjna struktura wywołania metody:
<?php
$client = new SoapClient('http://api.aligato.pl/server.php?wsdl');
$doGetCountriesRequest = [
    'sessionHandlePart' => 'cca2fdab811a780beab44e5f1867952b'
];
$response = $client->__soapCall('API.doGetCountries', $doGetCountriesRequest);
var_dump($response);

// Dane zwrócone
/*
array(2) {
  [0]=>
  object(stdClass)#2 (2) {
    ["countryName"]=>
    string(11) "Afghanistan"
    ["countryId"]=>
    string(3) "501"
  }
  [1]=>
  object(stdClass)#3 (2) {
    ["countryName"]=>
    string(7) "Albania"
    ["countryId"]=>
    string(3) "184"
  }
*/
API.doGetShippers
Pobranie listy wszystkich dostępnych metod dostawy
sessionHandlePart | string
wymagany

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

shippers | array

Tablica z metodami dostaw

  1. shipperId | integer | ID metody dostawy
  2. shipperName | string | Nazwa metody dostawy
    array(1) {
  [0]=>
  object(stdClass)#2 (2) {
    ["shipperName"]=>
    string(15) "Darmowa dostawa"
    ["shipperId"]=>
    string(2) "43"
  }
}

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

Orientacyjna struktura wywołania metody:
<?php
$client = new SoapClient('http://api.aligato.pl/server.php?wsdl');
$doGetShippersRequest = [
    'sessionHandlePart' => 'cca2fdab811a780beab44e5f1867952b'
];
$response = $client->__soapCall('API.doGetShippers', $doGetShippersRequest);
var_dump($response);

// Dane zwrócone
/*
array(1) {
  [0]=>
  object(stdClass)#2 (2) {
    ["shipperName"]=>
    string(15) "Darmowa dostawa"
    ["shipperId"]=>
    string(2) "43"
  }
}
*/
API.doGetMyUserID
Pobranie ID użytkownika (zalogowanego w API)
sessionHandlePart | string
wymagany

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

userId | long

ID użytkownika

    object(stdClass)#2 (1) {
  ["userId"]=>
  int(1)
}

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

Orientacyjna struktura wywołania metody:
<?php
$client = new SoapClient('http://api.aligato.pl/server.php?wsdl');
$doGetMyUserIDRequest = [
    'sessionHandlePart' => 'cca2fdab811a780beab44e5f1867952b'
];
$response = $client->__soapCall('API.doGetMyUserID', $doGetMyUserIDRequest);
var_dump($response);

// Dane zwrócone
/*
object(stdClass)#2 (1) {
  ["userId"]=>
  int(1)
}
*/
API.doGetMyBalances
Pobranie sald PLN i USD
sessionHandlePart | string
wymagany

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

PLN | float

Saldo w PLN

USD | float

Saldo w USD

    

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

Orientacyjna struktura wywołania metody:
<?php
$client = new SoapClient('http://api.aligato.pl/server.php?wsdl');
$doGetMyBalancesRequest = [
    'sessionHandlePart' => 'cca2fdab811a780beab44e5f1867952b'
];
$response = $client->__soapCall('API.doGetMyBalances', $doGetMyBalancesRequest);
var_dump($response);
API.doGetMyTransactions
Pobranie historii transkacji
sessionHandlePart | string
wymagany

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

transactionId | integer

ID transkacji

transactionValue | float

Wartość transakcji

transactionType | string

Typ Transakcji

    

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

Orientacyjna struktura wywołania metody:
<?php
$client = new SoapClient('http://api.aligato.pl/server.php?wsdl');
$doGetMyTransactionsRequest = [
    'sessionHandlePart' => 'cca2fdab811a780beab44e5f1867952b'
];
$response = $client->__soapCall('API.doGetMyTransactions', $doGetMyTransactionsRequest);
var_dump($response);
API.doGetUserLogin
Pobranie nazwy użytkownika poprzez ID
sessionHandlePart | string
wymagany

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

userId | long
wymagany

ID użytkownika

userLogin | string

Nazwa użytkownika

    object(stdClass)#2 (1) {
  ["userId"]=>
  int(1)
}

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

ID użytkownika

Orientacyjna struktura wywołania metody:
<?php
$client = new SoapClient('http://api.aligato.pl/server.php?wsdl');
$doGetUserLoginRequest = [
    'sessionHandlePart' => 'cca2fdab811a780beab44e5f1867952b',
    'userId' => ''
];
$response = $client->__soapCall('API.doGetUserLogin', $doGetUserLoginRequest);
var_dump($response);

// Dane zwrócone
/*
object(stdClass)#2 (1) {
  ["userId"]=>
  int(1)
}
*/
API.doGetUserInfo
Pobranie informacji o użytkowniku (data utworzenia konta, rating itd.)
sessionHandlePart | string
wymagany

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

userId | long
wymagany

ID użytkownika

feedbacks | boolean
opcjonalnie

true|false - czy chcemy pobrać opinie

userId | long

ID użytkownika

userLogin | string

Nazwa użytkownika

lastSeen | dateTime

Data ostatniego logowania

rating | float

Ocena punktowa użytkownika

feedbacks | array

Jeśli w żądaniu został przekazany parametr feedbacks = true w tym przypadku otrzymamy tabicę z opiniami o użytkowniku

  1. type | string | Rodzaj opini
  2. comments | string | Opinia
  3. auction | array | Informacja o ofercie której dotyczy komentarz
  4. createdAt | dateTime | Data i godzina wystawienia komentarza.
    object(stdClass)#2 (5) {
["userId"]=>
int(1)
["userLogin"]=>
string(5) "admin"
["lastSeen"]=>
string(24) "2018-06-17T21:46:45.000Z"
["rating"]=>
float(0)
["feedbacks"]=>
array(2) {
  [0]=>
  object(stdClass)#3 (4) {
    ["auction"]=>
    object(stdClass)#4 (2) {
      ["name"]=>
      string(27) "Test oferta - adres dostawy"
      ["id"]=>
      int(8) 93018301
    }
    ["type"]=>
    string(5) "buyer"
    ["comments"]=>
    string(17) "komentarz testowy"
    ["createdAt"]=>
    string(19) "2017-08-22 01:20:39"
  }
  [1]=>
  object(stdClass)#5 (4) {
    ["auction"]=>
    object(stdClass)#6 (2) {
      ["name"]=>
      string(30) "Oferta testowa dodatkowy adres"
      ["id"]=>
      int(8) 53017758
    }
    ["type"]=>
    string(5) "buyer"
    ["comments"]=>
    string(18) "bardzo dobry towar"
    ["createdAt"]=>
    string(19) "2017-08-21 22:57:39"
  }
}
}

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

ID użytkownika

true|false - czy chcemy pobrać opinie

Orientacyjna struktura wywołania metody:
<?php
$client = new SoapClient('http://api.aligato.pl/server.php?wsdl');
$doGetUserInfoRequest = [
    'sessionHandlePart' => 'cca2fdab811a780beab44e5f1867952b',
    'userId' => '',
    'feedbacks' => ''
];
$response = $client->__soapCall('API.doGetUserInfo', $doGetUserInfoRequest);
var_dump($response);

// Dane zwrócone
/*
object(stdClass)#2 (5) {
["userId"]=>
int(1)
["userLogin"]=>
string(5) "admin"
["lastSeen"]=>
string(24) "2018-06-17T21:46:45.000Z"
["rating"]=>
float(0)
["feedbacks"]=>
array(2) {
  [0]=>
  object(stdClass)#3 (4) {
    ["auction"]=>
    object(stdClass)#4 (2) {
      ["name"]=>
      string(27) "Test oferta - adres dostawy"
      ["id"]=>
      int(8) 93018301
    }
    ["type"]=>
    string(5) "buyer"
    ["comments"]=>
    string(17) "komentarz testowy"
    ["createdAt"]=>
    string(19) "2017-08-22 01:20:39"
  }
  [1]=>
  object(stdClass)#5 (4) {
    ["auction"]=>
    object(stdClass)#6 (2) {
      ["name"]=>
      string(30) "Oferta testowa dodatkowy adres"
      ["id"]=>
      int(8) 53017758
    }
    ["type"]=>
    string(5) "buyer"
    ["comments"]=>
    string(18) "bardzo dobry towar"
    ["createdAt"]=>
    string(19) "2017-08-21 22:57:39"
  }
}
}
*/
API.doNewAuctionExt
Wystawienie nowej aukcji w serwisie
sessionHandlePart | string
wymagany

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

fields | array
wymagany

Tablica struktur zawierających informacje o polach formularza sprzedaży

  1. itemName | string | Tytuł aukcji wymagany
  2. itemDescription | string | Opis aukcji wymagany
  3. auctionType | string | Typ aukcji wymagany
    Dostępne opcje
    1. fixed
    2. regular
    3. classified
    4. jobs
  4. auctionDetails | string | Detale aukcji wymagany
    Dostępne opcje
    1. public
  5. categoryId | integer | ID kategorii - listę kategorii można pobrać metodą @API.doGetCategories wymagany
  6. enhancements | array | Dodatki do aukcji opcjonalnie
    1. featured | boolean | Czy aukcja ma być wyróżniona w kategorii? opcjonalnie PŁATNE
    2. highlite | boolean | Czy aukcja ma być podświetlona? opcjonalnie PŁATNE
    3. bold | boolean | Czy nazwa aukcji ma być pogrubiona? opcjonalnie PŁATNE
    4. autoRelist | boolean | Czy aukcja ma być automatyczie wznawiana? opcjonalnie PŁATNE
    5. featuredSearchResults | boolean | Czy aukcja ma być wyróżniona w wynikach wyszukiawania opcjonalnie PŁATNE
  7. shipping | array | Dostawa (koszta i metody) wymagany
    1. country | integer | ID Kraju dostawy - listę dostępnych krajów uzyskasz za pomocą metody @API.doGetCountries wymagany
    2. service | integer | ID dostawcy - listę dostępnych dostawców uzyskasz za pomocą metody @API.doGetShippers wymagany
    3. price | float | Koszt dostawy wymagany
  8. shipMethod | string | Rodzaj dostawy wymagany
    Dostępne opcje
    1. flatrate
    2. localpickup
itemId | long

ID nowo utworzonej aukcji

itemUrl | string

Adres URL do aukcji

itemInfo | string

Koszta wystawienia oferty

    

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

Tablica struktur zawierających informacje o polach formularza sprzedaży

Orientacyjna struktura wywołania metody:
<?php
$client = new SoapClient('http://api.aligato.pl/server.php?wsdl');
$doNewAuctionExtRequest = [
    'sessionHandlePart' => 'cca2fdab811a780beab44e5f1867952b',
    'fields' => ''
];
$response = $client->__soapCall('API.doNewAuctionExt', $doNewAuctionExtRequest);
var_dump($response);
API.doChangeItem
Edycja aukcji
sessionHandlePart | string
wymagany

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

fields | array
wymagany

Tablica struktur zawierających informacje o polach formularza sprzedaży

  1. itemName | string | Tytuł aukcji wymagany
  2. itemDescription | string | Opis aukcji wymagany
  3. auctionType | string | Typ aukcji wymagany
    Dostępne opcje
    1. fixed
    2. regular
    3. classified
    4. jobs
  4. auctionDetails | string | Detale aukcji wymagany
    Dostępne opcje
    1. public
  5. categoryId | integer | ID kategorii - listę kategorii można pobrać metodą @API.doGetCategories wymagany
  6. enhancements | array | Dodatki do aukcji opcjonalnie
    1. featured | boolean | Czy aukcja ma być wyróżniona w kategorii? opcjonalnie PŁATNE
    2. highlite | boolean | Czy aukcja ma być podświetlona? opcjonalnie PŁATNE
    3. bold | boolean | Czy nazwa aukcji ma być pogrubiona? opcjonalnie PŁATNE
    4. autoRelist | boolean | Czy aukcja ma być automatyczie wznawiana? opcjonalnie PŁATNE
    5. featuredSearchResults | boolean | Czy aukcja ma być wyróżniona w wynikach wyszukiawania opcjonalnie PŁATNE
  7. shipping | array | Dostawa (koszta i metody) wymagany
    1. country | integer | ID Kraju dostawy - listę dostępnych krajów uzyskasz za pomocą metody @API.doGetCountries wymagany
    2. service | integer | ID dostawcy - listę dostępnych dostawców uzyskasz za pomocą metody @API.doGetShippers wymagany
    3. price | float | Koszt dostawy wymagany
  8. shipMethod | string | Rodzaj dostawy wymagany
    Dostępne opcje
    1. flatrate
    2. localpickup
itemId | long
wymagany

ID Aukcji do edycji

itemId | long

ID nowo utworzonej aukcji

itemUrl | string

Adres URL do aukcji

itemInfo | string

Koszta wystawienia oferty

    

ID sesji która została wcześniej zwrócona przez @API.doLoginEnc

Tablica struktur zawierających informacje o polach formularza sprzedaży

ID Aukcji do edycji

Orientacyjna struktura wywołania metody:
<?php
$client = new SoapClient('http://api.aligato.pl/server.php?wsdl');
$doChangeItemRequest = [
    'sessionHandlePart' => 'cca2fdab811a780beab44e5f1867952b',
    'fields' => '',
    'itemId' => ''
];
$response = $client->__soapCall('API.doChangeItem', $doChangeItemRequest);
var_dump($response);

v. 09.07.2018