Authentifizierung
Konto-API-Schlüssel, voller oder benutzerdefinierter Zugriff und wo du einen erstellst.
Jeder Aufruf von CPI trägt einen API-Schlüssel. Es gibt keine getrennte Client-ID, keinen OAuth-Handshake, keine Signatur, die du berechnen musst: ein Schlüssel, mit der Anfrage gesendet.
Einen Schlüssel erstellen
Schlüssel liegen im Dashboard, im Kontomenü unter Entwickler, auf dem Tab API-Schlüssel. Ein Projekt
hat einen eigenen Tab API, der denselben Schlüsseltyp erstellt, bereits auf dieses Projekt beschränkt,
sodass du nie eine app_id von Hand eintippst. Auch die interaktive Sandbox der API-Referenz
kann auf der Stelle einen für dich erstellen, damit du eine Methode ausprobieren kannst, bevor du etwas in
deinen eigenen Code einbaust.
Zum Erstellen eines API-Schlüssels ist eine Identitätsprüfung nötig, dieselbe Stufe-2-Prüfung, die Xuda verlangt, bevor es eine Telefonnummer, ein Postfach oder eine portable IP herausgibt. Ein Konto ohne verifizierte Angaben sieht eine Aufforderung zur Verifizierung, bevor sich das Schlüsselformular öffnet.
Geltungsbereich: als welches Konto der Schlüssel handelt
Ein Schlüssel wird mit einem von drei Geltungsbereichen erstellt und handelt immer für das Konto oder die App, für die er erstellt wurde:
- Konto: handelt direkt für dein Konto, so wie du es aus einer angemeldeten Dashboard-Sitzung tun würdest. Erreicht jede Methode, die ein normaler Konto-Schlüssel erreichen kann.
- App: wird auf dem eigenen API-Tab eines Projekts erstellt und an die
app_iddieses Projekts gebunden. - Full Stack VPS: wird automatisch ausgestellt, wenn du einen Full Stack VPS bereitstellst, beschränkt auf die beim Erstellen gewählten Fähigkeitsgruppen. Siehe Full Stack VPS für das, was das abdeckt.
Zugriff: voll oder benutzerdefiniert
Jeder Schlüssel wählt außerdem, wie viel der öffentlichen Oberfläche er erreichen kann:
- Voller Zugriff: alles, was das Konto über die API tun kann, auch Methoden, die nach der Erstellung des
Schlüssels hinzukamen. Private Methoden bleiben in jedem Fall ausgeschlossen:
private: trueist eine harte Mauer, bei jedem Aufruf geprüft, keine Voreinstellung, die voller Zugriff überschreibt. - Benutzerdefinierter Zugriff: eine ausdrückliche Zulassungsliste, die du aufbaust, indem du im
Schlüsselformular Methoden ankreuzt, nach Microservice gruppiert und mit den Feldern jeder Methode
direkt daneben. Eine später hinzugefügte Methode ist nicht enthalten, bis du zurückkommst und sie erlaubst.
Eine Methode mit der
clearancepublicist immer erreichbar, selbst mit einem benutzerdefinierten Schlüssel ohne angekreuzte Methode, da eine öffentliche Methode weder Sitzung noch Eintrag in der Zulassungsliste braucht.
Die Methoden, die API-Schlüssel erstellen, aktualisieren und auflisten (create_account_api_key,
get_app_api_keys und der Rest von api_module), sind mit einem API-Schlüssel nie erreichbar, mit Absicht:
Ein Zugangsdatum kann keine Zugangsdaten für das Konto erstellen oder ändern, bei dem es sich authentifiziert.
Verwalte Schlüssel über das Dashboard oder eine angemeldete Sitzung.
Den Schlüssel senden
Über einfaches REST ist der Schlüssel ein weiterer Anfrageparameter namens api_key: ein Feld im JSON-Body
bei POST, ein Query-String-Parameter bei GET. Beide Formen siehe
Eine Methode aufrufen.
Über MCP kommt derselbe Schlüssel stattdessen in einen Authorization: Bearer-Header, ein Feld api_key
gibt es dort nicht. Siehe MCP.
Ein API-Schlüssel ist ein Inhaber-Zugangsdatum: Wer ihn hält, handelt als dein Konto. Liefere nie einen in clientseitigem Code aus, committe ihn nicht und füge ihn in keinen geteilten Screenshot ein. Ersetze einen Schlüssel sofort, falls er an einer dieser Stellen auftaucht: Beim Ersetzen bleiben Name und Zugriffsmodus erhalten, und der alte Wert wird im selben Schritt widerrufen.