Centrum pomocyIntegracje

Dla: Administratorzy

Uwierzytelniaj żądania API za pomocą klucza

Wyślij swój klucz jako token nośnika do interfejsu API Panelu administracyjnego w celu zarządzania kluczem lub do interfejsu API portalu w celu uzyskania klucza centralnego i ogranicz go do swoich adresów IP.

W tym artykule5 sekcji

Zanim zaczniesz

Ta strona pokazuje, gdzie należy wysłać każdy z tych rodzajów danych. Klucz APIKlawisz Tajny token, stworzony w ramach integracji, który umożliwia Twojemu oprogramowaniu korzystanie z API centrum., Jak to zrobić, oraz dlaczego ktoś odrzuca żądanie o przesłanie tego przedmiotu.

Adresy

KlawiszAdres bazowyPrzykład
Zarządzanie kluczowymi elementamihttps://prd-api-manage.caseactive.com/v1/<hub id>/https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases
Zarządzanie kluczowymi importamihttps://prd-api-manage.caseactive.com/v1/integration/<hub id>/https://prd-api-manage.caseactive.com/v1/integration/ca-7e6d5c4b3a2f10/imports
Klucz do urządzeniahttps://prd-api-app.caseactive.com/v1/<hub id>/https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases
Klucz Hub, jeden przypadekhttps://prd-api-app.caseactive.com/v1/<hub id>/<case id>/https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts

Twój identyfikator hub to ca- I 14 znaków. Wygląda tak: Identyfikator centrum na Przegląd Na stronie każdego przypadku w twoim portalu znajduje się przycisk do pobrania kopii. Identyfikator przypadku jest również podany na tej stronie. cc- I 14 znaków, pokazanych tam jako ID sprawy.

Wysyłanie klucza

Niech klucz jest umieszczony w nagłówku Authorization każdego zdarzenia, po wyrazie Bearer i spacjacie.

curl https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/roles \
  -H "Authorization: Bearer YOUR_API_KEY"
  • Wysyłaj obiekty w formacie JSON za pomocą tagu Content-Type: application/json.
  • Klucz nie wygasa. Funkcjonuje do czasu, aż któryś z administratorów go wyłączy lub usunie z sekcji Integracja › Klucze.
  • Każdy nazwa kierowcy jest ponownie wyświetlana: nie ma żadnej sesji ani tokena do wymiany.
  • Data i czas są wyświetlane w UTC.

Ograniczanie miejsca jego użycia

Poniżej Źródło CIDR można ograniczyć klucz do publicznej adresu IPv4 systemu, np. 203.0.113.10, lub do określonego zakresu adresów, np. 203.0.113.0/24. API obsługuje tylko połączenia z użyciem adresu IPv4, więc próby użycia adresu lub zakresu IPv6 będą odrzucane podczas zapisania klucza. Prośba wpływająca z dowolnego miejsca będzie odrzucona z powodu błędu 401 LoginSourceIpException. Aby zmienić zakres adresów, patrz Restrict or revoke an API key.

Kiedy odmówiono wydania klucza

Każde odmowa jest w rzeczywistości błędem, który polega na niewłaściwym wykorzystaniu nazw message. Zobacz również Poradniki dotyczące obsługi błędów API i kodów statusowych.

StatusmessageDlaczegoCo robić
401UnauthorizedNie została wysłana żadna kluczowa informacja, albo te informacje nie stanowią w istocie klucza.Sprawdź nagłówek Authorization
401HostNotFoundExceptionID węzła w adresie nie istnieje.Kopiować ponownie Identyfikator centrum
401HostPurgingExceptionCentrum jest usuwane.Zapytaj administratora w twoim hubie.
401SessionNotFoundExceptionKlucz został usunięty, albo należy do innego centrum.Użyj aktualnego klucza do tego huba.
401LoginKeyInactiveExceptionKlucz jest wyłączony.Proszę administratora o włączenie tego funkcji.
401LoginKeyWrongApiExceptionKlucz zarządzający został wysłany do adresu klucza centralnego, albo odwrotnie.Użyj adresu dotyczącego typu klucza.
401LoginSourceIpExceptionTelefon przyszedł z zewnątrz zakresu możliwości odbiorcy.Proszę dzwonić z dozwolonej adresy, lub rozszerzyć zakres dostępnych numerów.
401LoginSourceCidrExceptionNie można odczytać danych z rejestru, w którym znajduje się klucz.Poprawione Źródło CIDR
403BotNotAllowedExceptionI zarządza kluczami, których nie może używać.Proszę zobaczyć „Zrozumienie tego, co może robić API”.
403ManageBillingInactiveExceptionPanel administracyjny twojego partnera zostało zamknięte po nieudanej transakcji płatniczej (można korzystać tylko z klucza do administracji).Proszę kierownika o aktualizację metody płatności.
403BillingReadOnlyExceptionAbstrakt usługi twojego „hubu” przestał obowiązywać, a jego portal jest tylko do czytania. Dlatego klucz do tego „hubu” może tylko czytać dane, ale nie może niczego zmieniać.Proszę o administratora, aby ponownie uruchomił usługę subskrypcji.
403CaseClosedExceptionA Hub Key próbował zmienić zamkniętą sprawę.Najpierw ponownie otwórz tę sprawę.
404CaseNotFoundExceptionNazwa klucza nie odpowiada żadnemu przypadkowi, ani nie znajduje się w obrębie danego klucza.Proszę sprawdzić identyfikator przypadku.
503LoginSessionExceptionCentrum było zbyt zajęte, aby sprawdzić klucz.Proszę spróbować ponownie wkrótce.

W przypadku numeru 401 zawsze oznacza to, że sama kluczowa informacja została odrzucona. Dlatego synchronizacja może się zatrzymać i powiadomić o tym kogoś. Inne błędy dotyczą samego połączenia.

Powiązane artykuły

Obsługa błędów API i kodów statusuPrzeczytaj treść błędu, co oznaczają kody 400, 401, 403, 404, 500 i 503 i dlaczego element, którego klucz dotyczy, nie widzi odpowiedzi 404.IntegracjeZrozum, co może zrobić APIDowiedz się, do czego służy klucz zarządzający i klucz centralny, dlaczego każdy klucz pełni funkcję wirtualnego asystenta i gdzie znajduje się pełna lista danych technicznych.IntegracjeOgranicz lub odwołaj klucz APIOgranicz klucz do określonych adresów IP, wyłącz go lub usuń i sprawdź, kiedy był ostatnio używany.Integracje · 2 min