Zum Hauptinhalt springen

Authentifizierung

ArchiCore verwendet API-Schlüssel zur Authentifizierung.

API-Schlüssel erhalten

  1. Melden Sie sich bei ArchiCore an
  2. Gehen Sie zu EinstellungenEntwickler
  3. Klicken Sie auf API-Schlüssel generieren
  4. Kopieren und speichern Sie Ihren Schlüssel sicher
warnung

API-Schlüssel werden nur einmal angezeigt. Speichern Sie sie sicher!

API-Schlüssel verwenden

Fügen Sie den Schlüssel im Authorization-Header ein:

curl -H "Authorization: Bearer sk_live_xxxxx" \
https://api.archicore.io/api/v1/projects

Oder als Query-Parameter (nicht empfohlen):

curl "https://api.archicore.io/api/v1/projects?api_key=sk_live_xxxxx"

Schlüsseltypen

PräfixTypBeschreibung
sk_live_ProduktionVollzugriff auf Ihr Konto
sk_test_TestEingeschränkter Zugriff, für Entwicklung

Schlüsselberechtigungen

API-Schlüssel erben Berechtigungen von Ihrer Kontostufe:

BerechtigungKostenlosProEnterprise
Projekte lesen
Projekte erstellen
Analyse
Webhooks-
Teamzugriff--

Schlüssel widerrufen

Um einen API-Schlüssel zu widerrufen:

  1. Gehen Sie zu EinstellungenEntwickler
  2. Finden Sie den Schlüssel in der Liste
  3. Klicken Sie auf Widerrufen

Widerrufene Schlüssel funktionieren sofort nicht mehr.

Sicherheits-Best-Practices

  1. API-Schlüssel niemals committen in Versionskontrolle
  2. Umgebungsvariablen verwenden zum Speichern von Schlüsseln
  3. Schlüssel regelmäßig rotieren (empfohlen: alle 90 Tage)
  4. Test-Schlüssel verwenden für Entwicklung
  5. Nutzung überwachen im Dashboard

Umgebungsvariablen

# .env (zu .gitignore hinzufügen!)
ARCHICORE_API_KEY=sk_live_xxxxx
const client = new ArchiCore({
apiKey: process.env.ARCHICORE_API_KEY
});

OAuth (Demnächst)

OAuth 2.0-Unterstützung ist für Team-Integrationen geplant.