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
| Klawisz | Adres bazowy | Przykład |
|---|---|---|
| Zarządzanie kluczowymi elementami | https://prd-api-manage.caseactive.com/v1/<hub id>/ | https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases |
| Zarządzanie kluczowymi importami | https://prd-api-manage.caseactive.com/v1/integration/<hub id>/ | https://prd-api-manage.caseactive.com/v1/integration/ca-7e6d5c4b3a2f10/imports |
| Klucz do urządzenia | https://prd-api-app.caseactive.com/v1/<hub id>/ | https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases |
| Klucz Hub, jeden przypadek | https://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.
| Status | message | Dlaczego | Co robić |
|---|---|---|---|
| 401 | Unauthorized | Nie została wysłana żadna kluczowa informacja, albo te informacje nie stanowią w istocie klucza. | Sprawdź nagłówek Authorization |
| 401 | HostNotFoundException | ID węzła w adresie nie istnieje. | Kopiować ponownie Identyfikator centrum |
| 401 | HostPurgingException | Centrum jest usuwane. | Zapytaj administratora w twoim hubie. |
| 401 | SessionNotFoundException | Klucz został usunięty, albo należy do innego centrum. | Użyj aktualnego klucza do tego huba. |
| 401 | LoginKeyInactiveException | Klucz jest wyłączony. | Proszę administratora o włączenie tego funkcji. |
| 401 | LoginKeyWrongApiException | Klucz zarządzający został wysłany do adresu klucza centralnego, albo odwrotnie. | Użyj adresu dotyczącego typu klucza. |
| 401 | LoginSourceIpException | Telefon przyszedł z zewnątrz zakresu możliwości odbiorcy. | Proszę dzwonić z dozwolonej adresy, lub rozszerzyć zakres dostępnych numerów. |
| 401 | LoginSourceCidrException | Nie można odczytać danych z rejestru, w którym znajduje się klucz. | Poprawione Źródło CIDR |
| 403 | BotNotAllowedException | I zarządza kluczami, których nie może używać. | Proszę zobaczyć „Zrozumienie tego, co może robić API”. |
| 403 | ManageBillingInactiveException | Panel 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. |
| 403 | BillingReadOnlyException | Abstrakt 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. |
| 403 | CaseClosedException | A Hub Key próbował zmienić zamkniętą sprawę. | Najpierw ponownie otwórz tę sprawę. |
| 404 | CaseNotFoundException | Nazwa klucza nie odpowiada żadnemu przypadkowi, ani nie znajduje się w obrębie danego klucza. | Proszę sprawdzić identyfikator przypadku. |
| 503 | LoginSessionException | Centrum 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.