Zum Inhalt springen
Documentation

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.

  1. Öffnen API Schlüssel.
  2. Wählen Sie einen Namen, der die Arbeitslast und die Umgebung eindeutig identifiziert.
  3. Wählen Sie für jeden Dienst eine Zugriffsebene aus und schränken Sie diese anschließend auf die Bereiche ein, 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.

Authorization: Bearer YOUR_API_KEY

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

Terminal-Fenster
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.

Der Bildschirm API„Schlüssel“ gruppiert die Dienste in vier Bereiche: Arbeitsbereich, Kommunikation, Entwickler und Admin. Wählen Sie für jeden Dienst eine Zugriffsebene aus und fügen Sie anschließend einzelne Bereiche hinzu oder entfernen Sie diese, falls die Arbeitslast eine engere Eingrenzung erfordert:

  • Keine: Der Schlüssel kann den Dienst nicht nutzen.
  • Lesen: die Bereiche in der Spalte „Lesen“.
  • Lesen & Schreiben: Lesen sowie die Bereiche in der Spalte „Schreiben“.
  • Admin: alle oben genannten Bereiche sowie die in der Spalte „Admin“ aufgeführten Bereiche für die Dienste, die über solche verfügen.

Markierte Bereiche Opt-in werden niemals nach Stufe ausgewählt. Markieren Sie sie anhand ihres Namens. Ein Dienst, der in Ihrem Tarif nicht enthalten ist, wird gesperrt angezeigt, mit einem Link zum Upgrade. Der Bildschirm zeigt stets den aktuell aktiven Katalog an.

DienstLesenSchreibenAdmin
Drivedrive:readdrive:write, drive:delete—
Dokumentedocs:read, docs:exportdocs:write, docs:share, docs:delete—
Tabellensheets:read, sheets:exportsheets:write, sheets:share, sheets:delete—
Notesnotes:readnotes:write—
Calendarcalendar:readcalendar:write—
Contactscontacts:readcontacts:write—
Workwork:readwork:write, work:delete—
Formsforms:readforms:write—
Invoiceinvoice:readinvoice:write, invoice:send, invoice:delete—
Organigrammecharts:readcharts:write, charts:delete—
Learncourses:readcourses:write—
Schule LMSNoch nicht über einen SchlüsselAPI verfügbar

DienstLesenSchreibenAdmin
Mailmail:readmail:write, mail:send—
Chatchat:readchat:write—
Meetmeet:readmeet:write—
RTCIn Kürze verfügbar. RTC verwendet eigene Projekt-SchlüsselAPI

DienstLesenSchreibenAdmin
CHAMPREP Codecode:read_api, code:read_repository, code:read_registry, code:read_package_registrycode:write_repository, code:write_registry, code:write_package_registrycode:api; Opt-in code:admin_mode
CHAMPREP QAqa:readqa:write—
Runner-Farmrunner_farm:readrunner_farm:write—
CLI—cli:use—
CHAMPREP AI—ai:chat; Opt-in ai:actions, ai:agent—
DienstLesenSchreibenAdmin
Businessbusiness:read—business:manage
Abrechnungbilling:read—billing:manage
Entwickler APIapi:read—api:manage, webhooks:manage
Profilusers:read——

Die Plattformverwaltung steht einem SchlüsselAPI niemals zur Verfügung; hierfür ist ein angemeldeter Administrator erforderlich.

  • CHAMPREP Code. Jedes code: Der Geltungsbereich entspricht dem gleichnamigen persönlichen Zugriffstoken-Geltungsbereich in CHAMPREP„Code“, und „Code“ überprüft diesen an jedem Endpunkt. code:api bieten vollen Lese- und Schreibzugriff auf alles, worauf Ihr Konto in Code zugreifen kann, und liegen somit auf der Admin-Ebene; bevorzugen Sie die enger gefasste read_ und write_ Gültigkeitsbereiche. Endpunkte zur Code-Verwaltung benötigen einen Schlüssel, der code:admin_mode nach Namen sowie ein Konto, das als Code-Administrator fungiert.
  • Runner-Farm. runner_farm:write registriert und verwaltet Runner, Pools und Verbindungen. Sie kauft niemals Guthaben und ändert keine Zahlungseinstellungen, und sie stellt niemals ein Connector-Geheimnis oder ein Runner-Token aus, ersetzt diese oder testet sie. Für diese Aktionen ist eine angemeldete Person erforderlich.
  • Dokumente und Tabellen. Freigabe (Mitarbeiter, Linkfreigabe, Veröffentlichung), dauerhafte Löschung oder Bereinigung sowie Export erfordern jeweils einen eigenen Geltungsbereich. Ein Schlüssel mit nur docs:write oder sheets:write können Inhalte bearbeiten, diese jedoch nicht freigeben, löschen oder exportieren.
  • CHAMPREP AI. ai:agent ermöglichen es, CLI KI-Agent verwenden lokale Tools und umfassen ai:chat. ai:actions genehmigt oder lehnt Aktionen ab, die die KI in Ihren DienstenCHAMPREP vorschlägt, und nichts anderes.

Der Platzhalter-Gültigkeitsbereich * (vollständiger Zugriff) decken alle in Ihrem Tarif enthaltenen Dienste ab, einschließlich CHAMPREPCode, Runner Farm und Docs. CHAMPREPCode behandelt dies als code:api, d. h. vollen Lese- und Schreibzugriff. Nicht enthalten sind ai:agent oder code:admin_mode; diese müssen stets namentlich ausgewählt werden.

Reservieren Sie den Platzhalter für streng kontrollierte administrative Integrationen und schränken Sie bestehende Vollzugriffsschlüssel ein, wenn diese die neueren Dienste nicht benötigen. Ein Gültigkeitsbereich erlaubt eine Kategorie von Aktionen; er hat keinen Vorrang vor Plan-, Rollen-, Organisations- oder Ressourcenberechtigungen.

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.

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.

Ü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.

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.