Korzystanie z naszych interfejsów API
Ja chcę po prostu użyć interfejsu API. Co to są plany?
Plan jest kolekcją zasobów interfejsu API lub podzbiorów zasobów z jednego lub większej liczby interfejsów API. Plan może zawierać operacje różnego typu pochodzące z różnych interfejsów API. Plan może mieć limit częstotliwości wspólny dla wszystkich zasobów lub każdy zasób może mieć inny limit częstotliwości. Limity częstotliwości określają, ile żądań aplikacja może wykonać w podanym przedziale czasu.
Za pomocą tego portalu Developer Portal można przeglądać różne dostępne plany i wybrać plan najbardziej odpowiedni dla danych wymagań. Dostęp do niektórych planów jest ograniczony i aby ich użyć, należy zażądać dostępu. Po wysłaniu żądania organizacja jest powiadamiana, administrator API sprawdza żądanie i może skontaktować się, aby uzyskać więcej szczegółowych informacji. Inne plany są dostępne do użycia od razu.
Jak wyświetlić użycie interfejsu API?
Na stronie aplikacji jest wyświetlona liczba żądań wykonanych przez aplikację dla różnych interfejsów API.
W menu głównym kliknij opcję Aplikacje, a następnie kliknij daną aplikację. W tabeli subskrypcji produktów będą widoczne wszystkie plany subskrybowane przez aplikację.
Dla każdego interfejsu API zawartego w tym planie można wyświetlić użycie w porównaniu z limitem częstotliwości planu.
W jaki sposób mogę przetestować interfejs API?
Interfejs API można przetestować z tego portalu Developer Portal.
Podczas przeglądania szczegółów dotyczących interfejsu API wyświetlana jest lista operacji zawartych w interfejsie API. Podany jest czasownik i ścieżka wywołania operacji.
Po kliknięciu operacji zostanie wyświetlonych więcej informacji na jej temat, jakie parametry może przyjmować, co zwraca, jakich możliwych kodów powrotu może używać i co one oznaczają.
Istnieje również przycisk Spróbuj, który pozwala wypróbować operację bezpośrednio z portalu Developer Portal.
Jeśli interfejs API wymaga identyfikatora klienta lub danych niejawnych klienta do identyfikacji, można podać te wartości w górnej części sekcji Wypróbuj.