Entwickler-Tools
CHAMPREP Entwicklertools bieten eine einheitliche Möglichkeit, unterstützte Workflows zu automatisieren, ohne einzelne Service-Backends aufzurufen. Authentifizierung, Servicezugriff, Gültigkeitsbereiche, Nutzungskontrollen und Audit-Kontext werden amAPI Gateway angewendet.
Wählen Sie einen Integrationspfad
Abschnitt betitelt „Wählen Sie einen Integrationspfad“| Pfad | Am besten geeignet für | Beginnen Sie hier |
|---|---|---|
| API Gateway | Direkte HTTPS-Integrationen und benutzerdefinierte Anwendungen | API Gateway – Überblick |
| CHAMPREP CLI | Interaktive Terminalarbeit, Skripte und CI-Jobs | CLI – Überblick |
| Webhooks | Ereignisgesteuerte Integrationen, die keine Abfragen durchführen sollten | Webhooks |
| Offiziell SDKs | Typisierte Clients für unterstützte Dienste und Frameworks | CHAMPREP SDKs |
| SCIM 2.0 | Provisionierung über einen Unternehmens-Identitätsanbieter | SCIM Provisionierung |
Alle NetzwerkbefehleCLI und offiziellen SDKAnfragen nutzen das Gateway. Vermeiden Sie es, Integrationen auf Basis der browserorientierten oder backend-internen URLs eines Dienstes zu entwickeln; diese Routen stellen keine stabile öffentliche Schnittstelle dar.
Schnellstart
Abschnitt betitelt „Schnellstart“- Melden Sie sich bei an undCHAMPREP öffnen Sie API Schlüssel.
- Erstellen Sie einen Schlüssel, der ausschließlich die für Ihre Integration erforderlichen Bereiche enthält.
- Speichern Sie den Schlüssel in einem Secret Manager oder im Schlüsselbund des Betriebssystems.
- Senden Sie eine Anfrage an das Produktions-Gateway:
export CHAMPREP_TOKEN='replace-with-your-api-key'
curl --fail-with-body \ --header "Authorization: Bearer $CHAMPREP_TOKEN" \ https://api.champrep.com/v1/auth/whoamiDie Antwort gibt das aktive Konto und den Anmeldekontext an. Fahren Sie fort mit Authentifizierung und SchlüsselAPI , bevor Sie Dienstbereiche hinzufügen.
Die Plattformkontrollen gelten weiterhin
Abschnitt betitelt „Die Plattformkontrollen gelten weiterhin“Ein gültiger Schlüssel umgeht nicht die Produktkontrollen, die in geltenCHAMPREP. Eine Anfrage kann nur fortgesetzt werden, wenn alle folgenden Bedingungen erfüllt sind:
- API Gateway Der Zugriff ist für den aktiven Tarif und das aktive Profil aktiviert.
- Der Zieldienst ist für den aktiven Tarif und die Organisation verfügbar.
- Der Schlüssel enthält den für die Methode und die Ressource erforderlichen Geltungsbereich.
- Die in Echtzeit pro Minute, täglich und dienstspezifisch erfolgenden Nutzungskontrollen ermöglichen dies.
- Die aktive Rolle ist berechtigt, den Vorgang im Ziel- Dienst auszuführen.
Aus diesem Grund sollte ein API-SchlüsselAPI als zusätzliche Schnittstelle zu demselben Konto betrachtet werden und nicht als Möglichkeit, Richtlinien für Konten, Tarife, Rollen oder Organisationen zu umgehen.