Przegląd dla programistów
API integracyjne exoCortex pozwala połączyć Państwa aplikacje z platformą:
- REST API v1 otwiera zgłoszenia, odczytuje ich stan i dodaje komentarze;
- webhooki wychodzące wysyłają do Państwa systemów podpisane zdarzenia dotyczące zgłoszeń;
- webhooki przychodzące odbierają alarmy i zdarzenia z narzędzi monitorowania, bezpieczeństwa oraz innych systemów ITSM;
- SCIM 2.0 synchronizuje użytkowników i grupy z Państwa dostawcy tożsamości;
- widget zbiera wnioski z Państwa witryny.
Od czego zacząć
Dział zatytułowany „Od czego zacząć”| Cel | Co przeczytać |
|---|---|
| Otwarcie pierwszego zgłoszenia w pięć minut | Pierwsze kroki |
| Użycie gotowego klienta w JavaScript, Pythonie lub bash | SDK i CLI |
| Parametry, odpowiedzi i przykłady dla każdego endpointu | Dokumentacja referencyjna API |
| Informacje o tym, co i kiedy może się zmienić | Wersje i wycofywanie funkcji |
| Konfiguracja kluczy, webhooków, widgetu lub SCIM z konsoli | Przewodniki dotyczące integracji |
W skrócie
Dział zatytułowany „W skrócie”| Adres | https://exocortex-api.ai-exo-cortex.com |
| Wersja | /api/v1, specyfikacja 1.1.0 |
| Format | JSON, UTF-8 |
| Uwierzytelnianie | Klucz API nhk.<keyid>.<secret> w Authorization: Bearer |
| Limity | 600 żądań na 60 sekund na klucz, chyba że skonfigurowano inaczej |
| Błędy | ok: false ze stałym code |
Dokumentacja referencyjna jest generowana ze specyfikacji OpenAPI interfejsu API: opisy i przykłady są w języku angielskim, tak jak w specyfikacji.