Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetCountries

Tematyka: Różne
Ostatnia zmiana: ---
Dostępność:
Metoda pozwala na pobranie listy wszystkich krajów dostępnych w serwisie.

  1. country-code | int | wymagany
    Identyfikator kraju.
  2. webapi-key | string | wymagany
    Klucz WebAPI użytkownika.



Orientacyjna struktura wywołania metody

$dogetcountries_request = array(
   'country-code' => 1,
   'webapi-key' => 'g2fe408289'
);

  1. country-array |  CountryInfoType[]
    Tablica struktur zawierających informacje o dostępnych krajach.
    1. country-id |  int
      Identyfikator kraju.
    2. country-name | string
      Nazwa kraju.


Orientacyjna struktura odpowiedzi serwera

$dogetcountries_response = array(
   'country-array' => array(
      array(
         'country-id' => 1,
         'country-name' => 'Polska'),
      array(
         'country-id' => 2,
         'country-name' => 'United Kingdom'),
      array(...))
);


  • ERR_INPUT_COUNTRY_ERROR
    Niepoprawny identyfikator kraju (wskazany kraj nie jest obsługiwany lub w parametrze przekazano zerową/pustą wartość).
  • ERR_WEBAPI_EXPIRED
    Data ważności klucza WebAPI została przekroczona.
  • ERR_WEBAPI_KEY
    Niepoprawna wartość klucza WebAPI lub klucz został zablokowany.
  • ERR_WEBAPI_KEY_INACTIVE
    Klucz WebAPI został zdezaktywowany (nie zaakceptowano warunków Regulaminu WebAPI).
  • ERR_WEBAPI_NOT_AVAIL
    Problemy z usługą Allegro WebAPI.

Allegro nie bierze odpowiedzialności za skutki wykorzystania zamieszczonych przykładów kodu, nie daje także gwarancji ich poprawnego działania. Widoczny kod ma charakter wyłącznie poglądowy i może zawierać błędy.

#1 (29.04.2010 r.) / php (Autor: danielnowacki)
  1. /**
  2. * Definicja metod klienta do komunikacji z usługami WebAPI
  3. *
  4. * @package Allegro/Client
  5. * @author Daniel Nowacki http://nowacki.org.pl
  6. * @version 1.0
  7. */
  8. abstract class Allegro_Client_Abstract extends SoapClient
  9. {
  10. ...
  11.  
  12. /**
  13. * Pobiera listę krajów
  14. *
  15. * Jeżeli parametr $hashById jest ustawiony w stan prawdy, to zwraca tablię
  16. * w postaci asocjacyjnej, gdzie hashem jest numer kraju, wpp. surowy wynik
  17. *
  18. * @param $hashById czy przekształcić wynik tablicę asocjacyjną
  19. * @return array lista krajów
  20. */
  21. public function getCountries($hashById = true)
  22. {
  23. $countries = $this->doGetCountries($this->config['country'], $this->config['webapikey']);
  24.  
  25. $countriesArray = null;
  26.  
  27. if ($hashById)
  28. {
  29. foreach($countries as $country)
  30. {
  31. $countriesArray[$country->{'country-id'}] = $country->{'country-name'};
  32. }
  33. }
  34.  
  35. return $hashById ? $countriesArray : $countries;
  36. }
  37.  
  38. ...
  39. }
#2 (29.11.2014 r.) / vb.net (Autor: WojciechMW)
  1. Public Class WebService
  2. Private mwdslService As AllegroWebService.servicePortClient
  3. Public Sub New()
  4. Try
  5. mwdslService = New AllegroWebService.servicePortClient()
  6. Catch ex As Exception
  7. MsgBox(ex.Message, MsgBoxStyle.OkOnly Or MsgBoxStyle.Exclamation, ex.Source)
  8. End Try
  9. End Sub
  10. Public Function GetCountries(ByVal WebApiKey As String) As Data.DataTable
  11. Dim Result As New DataTable("Countries")
  12. Result.Columns.Add("ID kraju", System.Type.GetType("System.Int32"))
  13. Result.Columns.Add("Nazwa", System.Type.GetType("System.String"))
  14. Result.Columns.Add("Klucz wersji", System.Type.GetType("System.Int32"))
  15. Try
  16. Dim Response As AllegroWebService.doGetCountriesResponse = mwdslService.doGetCountries(New AllegroWebService.doGetCountriesRequest(1, WebApiKey))
  17.  
  18. For Each Elem As AllegroWebService.CountryInfoType In Response.countryArray
  19. Result.Rows.Add(Elem.countryId, Elem.countryName, 0)
  20. Next
  21. Catch ex As Exception
  22. MsgBox(ex.Message, MsgBoxStyle.OkOnly Or MsgBoxStyle.Exclamation, ex.Source)
  23. Result.Rows.Clear()
  24. End Try
  25. Result.Columns(0).ReadOnly = True
  26. Result.Columns(1).ReadOnly = True
  27. Return Result
  28. End Function
  29. End Class