Skip to main content
Die öffentliche API wird unter /v1 auf der Origin Ihres Failproof AI-Dashboards bereitgestellt.

​
Schlüssel erstellen und eine Anfrage stellen

  1. Öffnen Sie Administration → Keys, wählen Sie Create key und wählen Sie das engste Berechtigungs-Preset, das die Integration abdeckt.
  2. Fügen Sie individuelle Berechtigungen nur bei Bedarf hinzu, erstellen Sie den Schlüssel und kopieren Sie das einmalig angezeigte Secret.
  3. Senden Sie eine Testanfrage an /v1/sessions und bestätigen Sie, dass der Schlüssel auf der Keys-Seite aktiv bleibt.
  4. Rotieren oder deaktivieren Sie den Schlüssel über sein Aktionsmenü, wenn sich der Eigentümer der Integration ändert. Die Drawer-Ansicht für neue API-Schlüssel mit Berechtigungs-Presets und individuellen Grants.
Der Erstellungs-Drawer ist oben abgebildet. Das einmalige Secret erscheint erst, nachdem Sie create ausgewählt haben – kopieren Sie es, bevor Sie die Bestätigung schließen.
Schlüssel sind auf eine Organisation und ein Berechtigungs-Set beschränkt. Eine Anfrage ohne die erforderliche Berechtigung des Endpunkts gibt 403 zurück und benennt die fehlende Berechtigung.

​
Organisationsauswahl

Ein organisationsbezogener Schlüssel agiert automatisch im Kontext seiner Organisation. Ein instanzweit gültiger Schlüssel kann pro Anfrage eine Organisation auswählen:
Verwenden Sie den Organisations-Umschalter im Dashboard-Header, bevor Sie Administration → Keys öffnen. Dort erstellte Schlüssel gehören zur ausgewählten Organisation. Bestätigen Sie den Organisations-Slug in der URL und den Schlüsseldetails, bevor Sie die Anmeldeinformation in die Automatisierung übernehmen.
Verwenden Sie die generierten Endpunkt-Seiten in diesem Abschnitt für aktuelle Pfade, Parameter, Berechtigungsanforderungen und Statuscodes. Die Spezifikation wird aus den Server-Route-Annotationen generiert und gegen den /v1-Router geprüft. Die aktuelle Spezifikation bietet vollständige Abdeckung für Routen, Methoden, Parameter, Berechtigungen und Statuscodes. Einige Response-Bodies bleiben absichtlich untypisiert, da der Server sie noch als dynamisches JSON konstruiert. Untersuchen Sie eine echte Antwort, bevor Sie einen stark typisierten Client für einen Endpunkt ohne Response-Schema generieren. Verwenden Sie Content-Type: application/json für JSON-Schreibvorgänge. Behandeln Sie 401 als fehlende oder ungültige Authentifizierung, 403 als gültige Identität ohne die erforderliche Berechtigung, 404 als fehlende oder für die Organisation nicht zugängliche Ressource, 409 als Zustandskonflikt und 422 als ungültiges Feld oder ungültigen Berechtigungswert. Fehlerantworten enthalten eine lesbare Meldung; bei Berechtigungsfehlern wird zudem der erforderliche Grant benannt.
Die Bereitstellung der Richtlinien-Durchsetzung wird absichtlich außerhalb der gewöhnlichen öffentlichen /v1-Oberfläche verwaltet. Verwenden Sie den unterstützten Cloud-Deployment-Workflow.