Authentifizierung und SchlüsselAPI

Die akzeptiertAPI Gateway bereichsgebundene SchlüsselCHAMPREPAPI für Serverintegrationen und Automatisierung. Zur Verwaltung von Schlüsseln werden browserbasierte Kontositzungen verwendet, jedoch sollte eine benutzerdefinierte Integration ihre Dienstanfragen mit einem APISchlüssel authentifizieren.

Schlüssel erstellen

1. Öffnen API Schlüssel.
2. Wählen Sie einen Namen, der die Arbeitslast und die Umgebung eindeutig identifiziert.
3. Wählen Sie nur die Dienstbereiche aus, die die Workload benötigt.
4. Fügen Sie eine IP-Whitelist hinzu, wenn die Workload über stabile ausgehende Adressen verfügt.
5. Kopieren Sie den Schlüssel einmalig und speichern Sie ihn in einem Secret Manager oder einem Schlüsselbund.

Erstellen Sie nicht für jede Anwendung einen einzigen Schlüssel mit weitreichendem Geltungsbereich. Getrennte Schlüssel machen die Rotation, die Audit-Prüfung und die Reaktion auf Vorfälle sicherer.

Senden Sie die Anmeldedaten

Authorization: Bearer YOUR_API_KEY

Für Shell-Beispiele speichern Sie den Wert in einer Umgebungsvariablen:

curl --fail-with-body \
  --header "Authorization: Bearer $CHAMPREP_TOKEN" \
  https://api.champrep.com/v1/auth/whoami

Fügen Sie einen Schlüssel nicht in eine URL, einen Abfrageparameter, ein Frontend-JavaScript-Bundle, eine mobile Anwendung, eine Protokollzeile oder ein Analyseereignis ein.

Gültigkeitsbereichskatalog

Die folgenden öffentlichen Bereiche sind nach Diensten gruppiert. Das Dashboard zeigt die Bereiche an, die dem Konto derzeit zur Verfügung stehen.

Dienst	Lesen oder verwenden	Schreiben oder verwalten
Identität	users:read, api:read, cli:use	api:manage
Drive	drive:read	drive:write, drive:delete
Chat	chat:read	chat:write
Calendar	calendar:read	calendar:write
Contacts	contacts:read	contacts:write
Meet	meet:read	meet:write
Notes	notes:read	notes:write
Learn	courses:read	courses:write
CHAMPREP AI	ai:chat	ai:chat
Mail	mail:read	mail:write, mail:send
Work	work:read	work:write, work:delete
Invoice	invoice:read	invoice:write, invoice:send, invoice:delete
Business	business:read	business:manage
Abrechnung	billing:read	billing:manage
Org Chart	charts:read	charts:write, charts:delete
CHAMPREP QA	qa:read	qa:write
Forms	forms:read	forms:write
Webhooks	—	webhooks:manage

Der Wildcard-Gültigkeitsbereich gewährt umfassenden Zugriff und sollte streng kontrollierten administrativen Integrationen vorbehalten bleiben. Ein Gültigkeitsbereich erlaubt eine Kategorie von Aktionen; er hat keinen Vorrang vor Berechtigungen auf Plan-, Rollen-, Organisations- oder Ressourcenebene.

Lebenszyklus von Schlüsseln

Rotieren

Erstellen oder generieren Sie einen Ersatzschlüssel neu, stellen Sie ihn bereit, vergewissern Sie sich, dass die Workload ihn verwendet, und widerrufen Sie anschließend den bisherigen Schlüssel. Vermeiden Sie eine Rotation, bei der eine unbeaufsichtigte Workload ohne gültige Anmeldedaten zurückbleibt.

Widerrufen

Entziehen Sie einen Schlüssel unverzüglich, wenn er offengelegt wurde, auf ein nicht vertrauenswürdiges System kopiert wurde oder nicht mehr zu einer aktiven Arbeitslast gehört. Ein widerrufener Schlüssel sollte 401 und dürfen nicht unbegrenzt wiederholt werden.

Überblick

Überprüfen Sie regelmäßig Schlüsselnamen, Gültigkeitsbereiche, IP-Einschränkungen, Informationen zur letzten Nutzung sowie die Audit-Aktivitäten. Löschen Sie ungenutzte Schlüssel, anstatt sie für ein mögliches zukünftiges Skript aufzubewahren.

Anmeldung über den Browser und AnmeldungCLI

champrep auth login verwendet einen Browser-Genehmigungsablauf für eine Person an einem Terminal. champrep auth token speichert einen bereichsgebundenen APISchlüssel für die Automatisierung. Die CLI schütztCLI gespeicherte Anmeldedaten mit dem Schlüsselbund des Betriebssystems und sendet alle netzwerkgebundenen Befehle über das Gateway.

Siehe CLI Authentifizierung und API Schlüssel für die AutomatisierungCLI für diese Arbeitsabläufe.