Erste Schritte
Authentifizierung und Zugriff
Verstehen Sie Mitgliedsschlüssel, Arbeitsbereichsgrenzen, Beschränkungen, Ablaufdaten und sichere Erneuerung.
Bearer-Schlüssel senden
Authentifizierte Endpoints akzeptieren Authorization: Bearer <API_KEY>. Schlüssel beginnen mit sqk_, gefolgt von 64 Hexadezimalzeichen. Ein Schlüssel ist an Eigentümer und Arbeitsbereich gebunden; die Anfrage enthält keine Arbeitsbereichsauswahl.
- Verwenden Sie den Schlüssel auf Ihrem Server. Diese API sendet keine CORS-Header.
- Speichern Sie Schlüssel nie in Browser-JavaScript, URLs, Versionsverwaltung oder öffentlichen Logs.
- Verwenden Sie HTTPS und getrennte Schlüssel für Entwicklung und Produktion.
Integration einschränken
Wählen Sie Beschränkungen bei der Schlüsselerstellung. Sie gelten zusätzlich zu den aktuellen Berechtigungen des Eigentümers.
| Beschränkung | Verhalten |
|---|---|
| Zugriff | read oder write (Lesen und Schreiben). POST /query ist ein Lesezugriff. |
| Ressourcen | Explizite Liste oder alle Katalogressourcen. Beziehungen erfordern beide Seiten. |
| IP-Adressen | Optionale IP/CIDR-Liste für die ausgehenden Serveradressen. |
| Ablaufdatum | Erforderlich. Die App bietet höchstens ein Jahr Laufzeit. |
Erneuern und widerrufen
Das Geheimnis wird einmal angezeigt; Squario speichert einen Hash. Erstellen Sie einen Ersatzschlüssel, aktualisieren Sie das Geheimnis der Integration, prüfen Sie mit /me und widerrufen Sie den alten unter Einstellungen → API. Benennen Sie Schlüssel nach der Integration, damit Verbrauch und Änderungen erkennbar sind.
- Abgelaufene und widerrufene Schlüssel funktionieren nicht mehr.
- Entzug der API-Berechtigung oder Tarifänderungen können einen vorhandenen Schlüssel sofort stoppen.
- Eine inaktive Mitgliedschaft widerruft ihre Schlüssel. Reaktivierung stellt sie nicht wieder her.
- Ablauferinnerungen sind 14 und 3 Tage vorher vorgesehen, abhängig von Benachrichtigungseinstellungen und Schlüssellaufzeit.
Wenn sich MFA ändert
Ein Schlüssel delegiert das Authentifizierungsniveau der Sitzung, die ihn erstellt hat. Macht ein neu bestätigter MFA-Faktor dieses Niveau veraltet, liefern Anfragen 401 key_assurance_stale. Melden Sie sich mit aktueller MFA an und erstellen Sie einen Ersatzschlüssel.
API-Zugriff und Verwaltung
api.access erlaubt Mitgliedern, eigene Schlüssel zu erstellen und zu verwenden. api.manage erlaubt Administratoren, Mitgliedsschlüssel einzusehen und zu widerrufen sowie den arbeitsbereichsweiten Verbrauch zu prüfen. API-Zugriff ist auf Pro, Growth, Scale und Enterprise verfügbar. Berechtigungen und Tarif werden bei jeder Anfrage erneut geprüft.