Jak działa API?

Api działa na zasadzie wysyłania zapytań do naszego serwera. Przykładem zapytania jest GET https://api.infirma.pl/api/klienci. W odpowiedzi serwer inFirmy zwróci listę klientów w formacie JSON. Lista dostępnych adresów jest tutaj: Adresy wywoływań.

W zapytaniu takim trzeba wysłać specjalne nagłówki X-SUMDOMENA i X-API-KEY (Jak przygotować zapytanie API?).

Jeżeli zapytanie zostanie poprawnie wykonane to serwer zwróci kod 200 wraz z odpowiednimi danymi.

Jeżeli w wyniku zapytania powstaną jakieś błędy to kod odpowiedzi będzie informacją o rodzaju błędu:

• 401 - brak poprawnej autoryzacji

• 403 - dostęp zabroniony

• 404 - strona nie została znaleziona

• 406 - błąd ogólny

• 409 - potrzebne dodatkowe informacje

• 400 - bład wewnętrzny