Przejdź do głównej zawartości
Wersja: 7.x

Pierwsze połączenie

Mając już prawidłowo skonfigurowany klucz API i dane uwierzytelniające (zgodnie z instrukcją konfiguracji), możemy nawiązać połączenie. Aby pobrać dane z serwera, należy najpierw uzyskać token uwierzytelniający. Poniższa instrukcja wyjaśnia, jak to zrobić.

Uzyskiwanie tokenu uwierzytelniającego​

W celu uzyskania tokenu wysyłamy do naszego serwera żądanie pod adres:

request 1

Do testowania tego procesu można użyć programu Postman. Na kolejnych zrzutach ekranu zostanie przedstawione krok po kroku, jak to zrobić.

W pierwszej kolejności potrzebna będzie wartość API Key. Aby ją pobrać, w sekcji administracyjnej wybierz z lewego menu Integracja ➞ Web service - aplikacje, a następnie przy interesującym Cię kluczu naciśnij przycisk , aby skopiować jego wartość.

api_key

Do zapytania API dodajemy nagłówki:

  • X-API-KEY. Jako wartość podajemy API Key skopiowany z systemu YetiForce.

  • Authorization. Dane uwierzytelniające w formacie Basic base64(userName:password), gdzie userName i password to dane uwierzytelniające aplikacji zarejestrowanej do korzystania z API w sekcji administracyjnej (z panelu Web service - aplikacje), a base64 oznacza zakodowanie ciągu znaków w standardzie base64.

W treści zapytania umieszczamy dane w formacie JSON:

  • userName - nazwa użytkownika web service.
  • password - hasło użytkownika web service.
  • params - dodatkowe parametry (opcjonalne), np. język "params": {"language": "en-EN"}.

Nazwa użytkownika i hasło przekazywane w treści zapytania to dane ustalone w sekcji administracyjnej w zakładce Web service - użytkownicy.

{
  "userName": "apiuser",
  "password": "apipassword",
  "params": {
    "language": "en-EN"
  }
}

request 2

Następnie podajemy dane do logowania zgodnie z poniższym zrzutem ekranu. Zamiast zmiennej {{URL}} podajemy adres naszej platformy YetiForce. Dane uwierzytelniające userName i password wpisujemy zgodnie z wartościami ustalonymi w sekcji administracyjnej w zakładce Integracja ➞ Web service - użytkownicy.

W informacji zwrotnej otrzymamy parametr token, który będziemy przekazywać w kolejnych żądaniach.

request 3

Kolejne żądania​

Po uzyskaniu wartości token możemy przejść do odpytywania API o interesujące nas dane. W tym celu do kolejnych żądań dodajemy nagłówek x-token z wartością uzyskanego tokena.

request 4

W zależności od tego, czy mamy wykupioną usługę Webservice Premium, czy też korzystamy z Webservice Standard, będziemy mieć do dyspozycji inny zakres dostępnych punktów końcowych.

Lista punktów końcowych dla poszczególnych usług​