wersja beta

Jak skorzystać z API?

Co to jest API MojeGS1?


ApiMojeGS1 to interfejs programistyczny – zbiór metod, dzięki którym możliwe jest podłączenie się do bazy MojeGS1 i uzyskanie niezbędnych informacji o produktach we własnej aplikacji.  Innymi słowy – jeżeli Twoja aplikacja mobilna, program WMS, ERP lub inna aplikacja stacjonarna, Twoja wyszukiwarka produktów na stronie internetowej, lub dowolne inne budowane przez Ciebie oprogramowanie (zgodnie z Regulaminem API) ma mieć możliwość korzystania z wiarygodnego źródła informacji – ApiMojeGS1 jest właściwym rozwiązaniem. Aby rozpocząć pracę z APIMojeGS1 wymagana jest podstawowa wiedza z zakresu programowania aplikacji z wykorzystaniem usług typu Webservice.


Jak zacząć?


Aby skorzystać z naszego API, należy wypełnić specjalny formularz kontaktowy. Po weryfikacji danych przez GS1 Polska, na podany w formularzu adres e-mail zostanie przesłany klucz, potrzebny do uruchomienia API. Od tego momentu będzie można przystąpić do uruchomienia komunikacji.
Do wyboru są dwie programistyczne metody komunikacyjne: SOAP, oraz REST (GET). Poniżej przedstawiamy przykłady korzystania z usług.


Najprostszy przykład zastosowania Webservice

Zacznijmy od konkretnego przykładu – proszę wprowadzić do przeglądarki WWW link poniżej, zamieniając "****" na "test_client":

http://api3.produktywsieci.pl/PublicService.svc/rest/xml/GetProductByGTIN?gs1Key=****&gtin=5909990278329

Jeżeli w przeglądarce wyświetliła się treść pliku XML – gratulacje! Właśnie wywołałeś testową usługę APIMojeGS1 (Webservice/REST) i dostałeś odpowiedź w postaci treści XML. Teraz wystarczy tylko zamiast „test_client” wprowadzić własny klucz, a odpowiedź webserwisu oprogramować i odpowiednio przetworzyć we własnej aplikacji.


Szczegółowe parametry Webservice


Web service dostępny jest pod adresem:

  • SOAP: http://api3.produktywsieci.pl/PublicService.svc?wsdl
  • REST (XML): http://api3.produktywsieci.pl/PublicService.svc/rest/xml/
  • REST (JSON): http://api3.produktywsieci.pl/PublicService.svc/rest/json/

Jedyną metodą wywołania WebService’u jest obecnie: GetProductByGTIN

Poniżej przedstawiamy parametry wywołania metody:

  • GS1Key – przesłany w e-mailu klucz API
  • gtin – numer GTIN, na który chcemy uzyskać odpowiedź (w formacie 14,13,12 lub 8 znaków). Numer musi zawierać cyfrę kontrolną, nie może mieć spacji ani myślników.
  • IP – adres IP osoby wywołującej zapytanie. Jeżeli wywołujący serwis jest serwisem końcowym – należy podać IP tego serwisu. Jeżeli serwsi występuje w roli pośrednika (np. prezentuje dane na stronie internetowej) należy podać adres IP osoby wywołującej tą stronę
  • geoloc – Tekstowa nazwa reprezentująca geolokację osoby zadającej pytanie, przykładowo „Poznań, wielkopolskie, Polska”
  • longtitude – szerokość geograficzna osoby zadającej pytanie
  • latitude – długość geograficzna osoby zadającej pytanie

Prawidłowe wywołanie powinno zawierać wszystkie w/w pola, jednakże ze względu na specyfikę i różnorodność serwisów mogących wywoływać API, istnieje możliwość zadawania pytań z wyłączeniem pól IP oraz geolokacyjnych – prosimy wówczas o napisanie uzasadnienia pominięcia tych pól w formularzu kontaktowym.

W celu testowania API (SOAP) polecamy użycie narzędzia WCFStorm lub SOAPUI dostępnego w internecie, natomiast składnia wywołania usługi REST wygląda następująco:

  • REST (XML): http://api3.produktywsieci.pl/PublicService.svc/rest/xml/GetProductByGTIN?gs1Key=*****&gtin=*****&ip=*****&geoloc=*****&longitude=*****&latitude=*****
  • REST (JSON): http://api3.produktywsieci.pl/PublicService.svc/rest/json/GetProductByGTIN?gs1Key=*****&gtin=*****&ip=*****&geoloc=*****&longitude=*****&latitude=*****

Odpowiedź web serwisu podzielona jest na klika sekcji:

  • CGS1Information – informacje o kodzie, kraju pochodzenia, jednostki nadającej kod
  • Contact – kontakt do osoby odpowiedzialnej w danej firmie za kody kreskowe
  • Owner – dane firmy uprawnionej do wykorzystywania kodu
  • Product – dane produktu

 Szczegółowy schemat XML odpowiedzi znajduje się pod adresem: http://api3.produktywsieci.pl/PublicService.svc?xsd=xsd2

Ładowanie
Proszę czekać...

Trwa wyszukiwanie informacji