Archbee CLI-Authentifizierungsleitfaden
Übersicht über die Authentifizierung
Die meisten Archbee CLI API-Befehle erfordern:
- --api-key
- --doc-space-id
Beispiel:
archbee search-docs --api-key YOUR_API_KEY --doc-space-id YOUR_SPACE_IDArten von API-Schlüsseln
Space-API-Schlüssel
Space-API-Schlüssel sind auf einen einzelnen Dokumentationsbereich beschränkt.
Sie können diese erstellen unter:
Space Settings → API keysTeam-API-Schlüssel
Team-API-Schlüssel beginnen mit:
abteam_Team-Administratoren können diese erstellen unter:
Settings → DeveloperTeam-API-Schlüssel können auf mehrere Bereiche zugreifen.
Wann --doc-space-id Erforderlich ist
Die meisten Befehle erfordern einen --doc-space-id-Wert, selbst wenn ein Team-API-Schlüssel verwendet wird.
Beispiel:
archbee get-doc --api-key abteam_xxx --doc-space-id SPACE_IDBefehle, die kein --doc-space-id
Diese Befehle auf Team-Ebene können nur mit einem Team-API-Schlüssel ausgeführt werden:
- Export
- Anzeigeregeln
- create-space
- hochladen
- Dateien auflisten
- Datei löschen
- Datei verschieben
- Datei ersetzen
Schreibgeschützte API-Schlüssel
Schreibgeschützte Team-API-Schlüssel können Inhalte nicht ändern.
Befehle wie diese schlagen mit schreibgeschützten Schlüsseln fehl:
- Dokument erstellen
- delete-doc
- publish-space
- update-space
Fehlerbehebung bei der Authentifizierung
Ungültiger API-Schlüssel
Überprüfen Sie:
- Der Schlüssel ist nicht abgelaufen
- Der Schlüssel gehört zum richtigen Team oder Bereich
- Der Befehl enthält keine zusätzlichen Leerzeichen oder Anführungszeichen
Fehler beim Bereichszugriff
Stellen Sie sicher, dass der API-Schlüssel Berechtigung für den Zugriff auf den angegebenen Bereich hat.
Befehlsberechtigung verweigert
Verwenden Sie für Befehle, die Daten ändern, einen Team-Schlüssel mit Schreibberechtigung.