Verwalten Ihrer API-Consumer-Apps und Anmeldeinformationen
Administratoren der Kundenintegration oder VMS-Benutzer können ihre API-Verbraucher-Apps registrieren und die für den Zugriff auf die CCW-API erforderlichen Anmeldeinformationen über eine Self-Service-Funktion verwalten.
Benutzer, die sich über die neueste CCW-REST-API authentifizieren, haben jetzt mehr Kontrolle über die Sicherheit durch eine neue Self-Service-Funktion, die es Kundenintegrationsadministratoren oder VMS-Benutzern ermöglicht, ihre API-Verbraucher-Apps zu registrieren und die für den Zugriff auf die API erforderlichen Anmeldeinformationen zu verwalten.
So funktioniert es
Kunden und Partner, die in CCW-APIs integrieren möchten, müssen ihr System als API-Verbraucher-App registrieren, bei der es sich um eine Reihe von CCW-API-Ressourcen handelt, auf die mit einem gemeinsamen Satz von Anmeldeinformationen zugegriffen werden kann. Apps sind mit einer Reihe von API-Bereichen und Berechtigungen verknüpft, die die Ressourcen steuern, auf die die API zugreifen kann, und die Aktionen, die sie ausführen kann.
Registrieren Sie eine neue App
Kundenintegrationsadministratoren können zu Integrationstoolkit > API-Verbraucher-Apps navigieren und auf „ Erstellen“ klicken, um eine API-Verbraucher-App zu registrieren.
Geben Sie die folgenden Informationen an, um Ihre API-App zu erstellen (alle Felder sind erforderlich).
- Anwendungsname - Geben Sie einen Namen ein, der Ihre API-App identifiziert.
- Anwendungsbeschreibung - Beschreiben Sie, wozu die App verwendet wird.
- Erste/Letzte/E-Mail-Adresse kontaktieren - Geben Sie den Namen und die E-Mail-Adresse einer Person ein, an die sich das Support-Team von CCW wenden kann, wenn es technische Probleme mit der App gibt.
- Anwendungstyp - Derzeit werden nur OpenId Connect-Apps unterstützt, die gesichtslose Machine-to-Machine-Integrationen mit Gewährungstypen für Client-Anmeldeinformationen erfordern. In zukünftigen Versionen werden Web- und Geräte-Apps unterstützt, die Autorisierungscode, Gerätecode und andere Gewährungstypen erfordern.
- Anwendungskategorie - Wählen Sie die Kategorie, die am besten zutrifft: Kunde, Partner, Lieferant oder MSP.
- Aktiv - Apps sind standardmäßig auf den Status Aktiv eingestellt. Entfernen Sie das Häkchen, um die App inaktiv zu machen.
- Anmeldedatentyp - Auf Shared Secret eingestellt . Ihr Geheimnis wird generiert, wenn diese Einstellungen gespeichert werden. In einer zukünftigen Version wird auch der auf json Web Key (JWKS) basierende Anmeldedatentyp unterstützt.
- Client-ID (schreibgeschütztes Feld) - Die automatisch generierte Client-ID ist Teil Ihrer OAuth 2.0-Client-Anmeldeinformationen, die zur Authentifizierung von Anfragen an die CCW-API verwendet werden. Die Client-ID ist eine eindeutige zufällige Zeichenfolge, die mit "CCW" + Ihrem Client-Präfix beginnt. Um die Client-ID zu kopieren, klicken Sie auf die Schaltfläche Kopieren rechts vom Feld.
- API-Benutzer - Wählen Sie einen vordefinierten API-Benutzer (entweder einen Client-, MSP- oder Lieferantenbenutzer) basierend auf der von Ihnen ausgewählten Anwendungskategorie aus.
-
Umfänge - Jede CCW-API erfordert einen bestimmten Umfang oder Endpunkt. APIs sind derzeit mit einem Umfang verfügbar:
- Kandidaten - als ccw.candidates
- Beschäftigte mit Zeitvertrag - als ccw.contingent_workers
Speichern Sie den Vorgang. Ihr Client-Geheimnis wird generiert und in einem grünen Banner angezeigt. Kopieren/fügen Sie das Client-Geheimnis ein und speichern Sie es an einem sicheren Ort, bevor Sie das Banner schließen, indem Sie auf das X klicken.
Wenn Sie Ihr Kundengeheimnis verlieren, müssen Sie Ihre Anmeldeinformationen neu generieren, indem Sie die App bearbeiten und neben dem Feld Kunden-ID auf Generieren klicken. Aus Sicherheitsgründen wird das Client Secret nicht auf dem CCW-System gespeichert.
Ihre Apps anzeigen
Wenn Apps bereits von Ihnen oder anderen in Ihrer Organisation erstellt wurden, wird ein Raster mit Ihren vorhandenen Apps angezeigt, wenn Sie zu Integration Toolkit > API Consumer Apps navigieren.
Die Spalte Status gibt an, ob eine App aktiv oder inaktiv ist. Klicken Sie auf die drei Punkte rechts von der Spalte Status, um die App in dieser Zeile zu bearbeiten. Für inaktive Apps ist auch die Option zum Löschen der App verfügbar.
Wenn eine lange Liste von Apps vorhanden ist, können Sie nach App-Namen oder -Kategorien sowie nach Benutzern (in der Spalte Erstellt von), Daten (in den Spalten Erstellt am und Zuletzt geändert) usw. suchen. Geben Sie einfach in das Suchfeld ein und klicken Sie auf das Lupensymbol, um die Ergebnisse einzugrenzen.
Rollen und Rechte
Neue Zugriffsrechte bestimmen, ob ein Benutzer auf das Integration Toolkit > API Consumer Apps zugreifen kann , um vorhandene Apps anzuzeigen und/oder eine neue App (s) zu erstellen (zu registrieren) und Anmeldeinformationen zu verwalten:
- Integrations-Toolkit > API-Verbraucher-Apps > API-Client-App anzeigen - ermöglicht den Zugriff auf die Liste der API-Verbraucher-Apps. Standardmäßig deaktiviert.
- Integration Toolkit > API Consumer Apps > API Client App verwalten - ermöglicht den Zugriff auf die Erstellung und Verwaltung von API Consumer Apps. Standardmäßig deaktiviert.