DOCS

Zacznij

Zacznij korzystać z interfejsu API Zonos

Witaj w dokumentacji referencji API Zonos.

Uwaga: Zonos obecnie używa GraphQL jako podstawowego API z pełną obsługą funkcji. Punkty końcowe REST są utrzymywane z ograniczoną obsługą tylko dla starszych integracji. W przypadku nowych integracji użyj naszego GraphQL API.

Interfejs API REST Zonos oferuje adresy URL zorientowane na zasoby, zwraca odpowiedzi zakodowane w formacie JSON, akceptuje ciała żądań zakodowane w formie i używa standardowych kodów odpowiedzi HTTP oraz uwierzytelniania.

Aby uzyskać dostęp do interfejsu API Zonos, potrzebujesz klucza API. Ten sam klucz API będzie używany do celów testowania i gdy integracja będzie na żywo. Klucz API jest używany do uwierzytelniania żądań.

Okresowo będziemy dodawać pola do naszego API. Aby zapobiec błędom po zintegrowaniu się z naszym API, zalecamy ignorowanie nieznanych pól.

Uwierzytelnianie 

Zonos używa kluczy API, aby umożliwić dostęp do API. Możesz zarejestrować nowe konto Zonos i klucz API tutaj.

Klucz API będzie zawarty w każdym żądaniu API do serwera w nagłówku, który wygląda następująco:

serviceToken: meowmeowmeow

Uwaga: Upewnij się, że zamieniłeś meowmeowmeow na swój klucz API.

Wersja 

Aby uzyskać dostęp do wersji API REST, wyślij nagłówek zonos-version. Przejrzyj odpowiednią dokumentację API, aby uzyskać odpowiednie informacje o nagłówku, jeśli ma zastosowanie i jest wymagane.

Jeśli nie została określona żadna wersja, domyślnie zostanie ustawiona ostatnia obsługiwana wersja.

Bieżący nagłówek wersji to zonos-version: 2021-01-01.

Czy ta strona była pomocna?