Verwalten Ihrer API-Consumer-Apps und -Anmeldeinformationen

Benutzer, die sich über neueste CCW REST-API haben jetzt mehr Kontrolle über die Sicherheit durch eine neue Self-Service-Funktion, mit der Kundenintegrationsadministratoren oder VMS-Benutzer ihre API-Consumer-Apps registrieren und die für den Zugriff auf die API erforderlichen Anmeldeinformationen verwalten können.

So funktioniert es

Kunden und Partner, die eine Integration in CCW-APIs wünschen, müssen ihr System als API-Consumer-App, Hierbei handelt es sich um eine Reihe von CCW-API-Ressourcen, 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.

Neue App registrieren

Kunden-Integrationsadministratoren können zu navigieren Integrations-Toolkit > API Consumer Apps und klicken Sie Erstellen , um eine API-Consumer-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, wofür die App verwendet wird.
• Erste/letzte E-Mail-Adresse des Kontakts - Geben Sie den Namen und die E-Mail-Adresse einer Person ein, die das CCW-Supportteam kontaktieren kann, wenn technische Probleme mit der App auftreten.
• Anwendungstyp - Derzeit nur OpenId Connect-Apps, die gesichtslose Maschine an Maschine Integrationen mit Kundenanmeldeinformationen Zuschusstypen werden unterstützt. In zukünftigen Versionen benötigen Web- und Geräte-Apps Autorisierungscode, Gerätecode und andere Zuschusstypen werden unterstützt.
• Anwendungskategorie - Wählen Sie die am besten zutreffende Kategorie aus: Kunde, Partner, Lieferant oder MSP
• Aktiv - Apps sind eingestellt auf Aktiv standardmäßig angezeigt. Entfernen Sie das Häkchen, um die App zu erstellen Inaktiv ,
• Anmeldeinformationstyp - Auf Shared Secret , Ihr Geheimnis wird generiert, wenn diese Einstellungen gespeichert werden. In einer zukünftigen Version wird auch der auf JSON Web Key (JWKS) basierende Anmeldeinformationstyp unterstützt.
• Kunden-ID (schreibgeschütztes Feld) - Die automatisch generierte Kunden-ID ist Teil Ihrer OAuth 2.0-Client-Anmeldeinformationen, die zur Authentifizierung von Anforderungen an die CCW-API verwendet werden. Client-ID ist eine eindeutige zufällige Zeichenfolge, die mit "CCW" + Ihrem Kundenpräfix beginnt. Um die Kunden-ID zu kopieren, klicken Sie auf die Schaltfläche Kopieren rechts neben dem Feld.
• API-Benutzer Wählen Sie einen vordefinierten API-Benutzer (entweder einen Kunden-, MSP- oder Lieferantenbenutzer) basierend auf der von Ihnen ausgewählten Anwendungskategorie aus.

• Geltungsbereiche - Jede CCW-API erfordert einen bestimmten Umfang oder Endpunkt. APIs, die derzeit mit einem Umfang verfügbar sind:
  • Kandidaten - als cw-Kandidaten
  • Beschäftigte mit Zeitvertrag - als ccw.contingent_workers

Klicken Speichern Sie den Vorgang. Ihr Kundengeheimnis wird generiert und in einem grünen Banner angezeigt. Kopieren/fügen Sie den Kundengeheimnis ein und speichern Sie ihn an einem sicheren Ort, bevor Sie das Banner schließen, indem Sie auf das X klicken.

Ihre Apps anzeigen

Wenn Apps bereits von Ihnen oder anderen in Ihrem Unternehmen erstellt wurden, wird ein Raster mit Ihren vorhandenen Apps angezeigt, wenn Sie zu navigieren Integrations-Toolkit > API Consumer Apps ,

Die Status Spalte gibt an, ob eine App Aktiv oder Inaktiv , Klicken Sie auf die drei Punkte rechts neben der Spalte Status, um Bearbeiten die App in dieser Zeile. Für inaktive Apps kann die Option Löschen die App ist ebenfalls verfügbar.

Wenn es eine lange Liste von Apps gibt, können Sie nach App-Namen oder Kategorien suchen, sowie nach Benutzern (in der Spalte Erstellt von aufgeführt), Daten (in den Spalten Erstellungsdatum und Letzte Änderung aufgeführt) usw. Geben Sie einfach Suche und klicken Sie auf das Lupensymbol, um die Ergebnisse einzugrenzen.

Rollen und Rechte

Neue Zugriffsrechte bestimmen, ob ein Benutzer auf Integrations-Toolkit > API Consumer Apps um vorhandene Apps anzuzeigen und/oder eine neue App zu erstellen (zu registrieren) und Anmeldeinformationen zu verwalten:

• Integrations-Toolkit > API-Consumer-Apps > API-Client-App anzeigen - Ermöglicht den Zugriff, um die Liste der API-Consumer-Apps anzuzeigen. Standardmäßig deaktiviert.
• Integrations-Toolkit > API-Consumer-Apps > API-Client-App verwalten - ermöglicht den Zugriff zum Erstellen und Verwalten von API-Consumer-Apps. Standardmäßig deaktiviert.