HilfezentrumIntegrationen

Für: Administratoren

Authentifizieren Sie API-Anfragen mit einem Schlüssel

Senden Sie Ihren Schlüssel als Bearer-Token an die API des Admin-Panels für einen Verwaltungsschlüssel oder an die API des Portals für einen Hub-Schlüssel und beschränken Sie ihn auf Ihre IP-Adressen.

In diesem Artikel5 Abschnitte

Bevor Sie beginnen

Diese Seite beschreibt, wohin man jede Art von API-SchlüsselSchlüssel Ein geheimer Token, der im Rahmen der Integration erstellt wird und es Ihrer eigenen Software ermöglicht, die API des Hubs zu nutzen. senden sollte, wie dies zu tun ist und warum ein Schlüssel abgewiesen wird.

Adressen

SchlüsselBasisadresseBeispiel
Verwalten der wichtigen Elementehttps://prd-api-manage.caseactive.com/v1/<hub id>/https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases
Verwalten der wichtigen Importehttps://prd-api-manage.caseactive.com/v1/integration/<hub id>/https://prd-api-manage.caseactive.com/v1/integration/ca-7e6d5c4b3a2f10/imports
Hub-Tastehttps://prd-api-app.caseactive.com/v1/<hub id>/https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases
Hub Key – ein Fallhttps://prd-api-app.caseactive.com/v1/<hub id>/<case id>/https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts

Ihr Hub-ID ist ca- Und 14 Zeichen. Es wird so angezeigt: Hub-ID Auf dem… Überblick Auf jeder Seite Ihres Portals gibt es eine Liste mit den Fällen. Dazu gibt es auch einen Button, mit dem man eine Kopie des jeweiligen Falles herunterladen kann. Die Fall-ID wird dabei angezeigt. cc- Und 14 Zeichen – wie dort dargestellt. Fall-ID.

Senden des Schlüssels

Senden Sie den Schlüssel im Authorization-Header jeder Anfrage. Dies sollte nach Bearer und einem Leerzeichen erfolgen.

curl https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/roles \
  -H "Authorization: Bearer YOUR_API_KEY"
  • Senden Sie JSON-Daten mit dem Attribut Content-Type: application/json.
  • Ein Schlüssel verliert seine Gültigkeit nicht. Er bleibt gültig, solange ein Administrator ihn deaktiviert oder aus der Liste in Integration › Schlüssel löscht.
  • Jeder Callsign wird neu vergeben: Es gibt keine Sitzung oder Token, die ausgetauscht werden müssten.
  • Die Daten und Zeiten werden in UTC angegeben.

Einschränkung der Anwendungsbereiche

Unter Quell-CIDR kann eine API-Schlüsselzugangskennung auf die öffentliche IPv4-Adresse Ihres Systems beschränkt werden – beispielsweise 203.0.113.10. Es kann auch ein bestimmtes Adressraum beschränkt werden – beispielsweise 203.0.113.0/24. Die API akzeptiert nur IPv4-Verbindungen. Daher wird eine IPv6-Adresse oder ein IPv6-Adressraum bei der Speicherung abgelehnt. Eine Anfrage von überall anderen Orten wird mit dem Fehler 401 LoginSourceIpException abgelehnt. Um den Adressraum zu ändern, siehe Restrict or revoke an API key.

Wenn ein Schlüssel verweigert wird

Jeder Ablehnung wird als Fehlerbericht zurückgegeben – dabei werden die Namen von message als Fehler angezeigt. Siehe dazu Umgang mit API-Fehlern und Statuscodes.

StatusmessageWarumWas zu tun
401UnauthorizedEs wurde keine Schlüssel gesendet – oder der gesendete Inhalt ist kein Schlüssel.Prüfen Sie den Header Authorization.
401HostNotFoundExceptionDie Hub-ID im Adresszeichen existiert nicht.Kopieren Sie Hub-ID noch einmal.
401HostPurgingExceptionDer Hub wird gelöscht.Fragen Sie einen Administrator Ihres Netzwerks.
401SessionNotFoundExceptionDer Schlüssel wurde gelöscht oder gehört zu einem anderen Hub.Verwenden Sie für diesen Hub einen aktuellen Schlüssel.
401LoginKeyInactiveExceptionDie Schlüssel ist ausgeschaltet.Bitten Sie einen Administrator, es einzuschalten.
401LoginKeyWrongApiExceptionEine Schlüsselinformation wurde an die Adresse des Hub-Schlüssels gesendet – oder umgekehrt.Verwenden Sie die Adresse für den Typ der Schlüssel.
401LoginSourceIpExceptionDer Anruf kam aus dem Bereich, der außerhalb des Reichweites der Schlüssel lag.Rufen Sie von einer erlaubten Adresse aus an – oder erweitern Sie das Spektrum der möglichen Anrufer.
401LoginSourceCidrExceptionDer gespeicherte Schlüsselbereich kann nicht gelesen werden.Richtig: Quell-CIDR
403BotNotAllowedExceptionEin Schlüssel, der einen Namen trägt – doch dieser Name kann nicht verwendet werden.Siehe Verstehen, was die API kann.
403ManageBillingInactiveExceptionDas Administrationspanel Ihres Servers ist nach einem fehlgeschlagenen Zahlungsvorgang gesperrt. Sie können nur noch die Schlüsselverwaltung durchführen.Bitten Sie einen Administrator, die Zahlungsmethode zu aktualisieren.
403BillingReadOnlyExceptionDie Abonnementlizenz Ihres Hub ist abgelaufen, und der entsprechende Portalbereich ist nur noch als „Lesebereich“ nutzbar. Daher kann eine Hub-Key zwar Informationen lesen, aber nichts ändern.Bitten Sie einen Administrator, die Abonnementaktivität erneut zu starten.
403CaseClosedExceptionEin Hub-Key versuchte, einen geschlossenen Fall zu ändern.Öffnen Sie das Fach zuerst wieder.
404CaseNotFoundExceptionEs gibt einen „Hub-Key“, der auf einen nicht existierenden Fall verweist – oder auf einen Fall, der nicht in Ihrem Hub enthalten ist.Prüfen Sie die Fallnummer.
503LoginSessionExceptionDer Hub war zu beschäftigt, um die Schlüssel zu überprüfen.Versuchen Sie es noch einmal in Kürze.

Ein Fehler bei der Nummer 401 bedeutet immer, dass die Schlüssel selbst abgelehnt wurden. Dadurch kann die Synchronisation zum Stillstand kommen und jemanden warnen. Andere Fehler beziehen sich auf den eigentlichen Anruf.

Verwandte Artikel

API-Fehler und Statuscodes behandelnLesen Sie den Fehlertext, was 400, 401, 403, 404, 500 und 503 bedeuten und warum ein Element, dessen Schlüssel nicht angezeigt werden kann, 404.IntegrationenVerstehen Sie, was die API leisten kann.Erfahren Sie, welche Funktionen eine Verwaltungstaste und eine Hub-Taste jeweils haben, warum jede Taste als virtueller Assistent fungiert und wo Sie die vollständige technische Auflistung finden.IntegrationenEinen API-Schlüssel einschränken oder widerrufenBeschränken Sie einen Schlüssel auf bestimmte IP-Adressen, schalten Sie ihn ab oder löschen Sie ihn und sehen Sie, wann er zuletzt verwendet wurde.Integrationen · 2 min