Gestion de vos applications API grand public et de vos identifiants

Les utilisateurs qui s'authentifient via la dernière API REST CCW ont désormais plus de contrôle sur la sécurité grâce à une nouvelle fonctionnalité en libre-service qui permet aux administrateurs d'intégration client ou aux utilisateurs de VMS d'enregistrer leurs applications grand public API et de gérer les informations d'identification requises pour accéder à l'API.

Comment ça marche

Les clients et les partenaires qui cherchent à s'intégrer aux API CCW doivent enregistrer leur système en tant qu'application de consommation d'API, qui est un ensemble de ressources d'API CCW accessibles avec un ensemble commun d'informations d'identification. Les applications sont associées à un ensemble d'étendues d'API et d'autorisations qui contrôlent les ressources auxquelles l'API peut accéder et les actions qu'elle peut entreprendre.

Enregistrer une nouvelle application

Les administrateurs de l'intégration client peuvent accéder à Integration Toolkit > API Consumer Apps et cliquer sur Créer pour enregistrer une application API grand public.

Fournissez les informations suivantes pour créer votre application API (tous les champs sont obligatoires).

• Nom de l'application - Entrez un nom qui identifie votre application API.
• Description de l'application - Décrivez à quoi sert l'application.
• Contact First/Last/Email Address - Entrez le nom et l'adresse e-mail de quelqu'un que l'équipe d'assistance de la CCW peut contacter en cas de problèmes techniques avec l'application.
• Type d'application - Actuellement, seules les applications OpenId Connect qui nécessitent des intégrations machine à machine sans visage avec des types de subvention d'identifiants client sont prises en charge. Dans les versions futures, les applications Web et les appareils nécessitant un code d'autorisation, un code d'appareil et d'autres types de subventions seront pris en charge.
• Catégorie d'application - Sélectionner la catégorie qui s'applique le mieux : Client, partenaire, fournisseur ou MSP.
• Actif - Les applications sont définies sur l'état Actif par défaut. Supprimer la coche pour rendre l'application inactive.
• Type d'identifiant - Définir sur Secret partagé . Votre Secret est généré lorsque ces paramètres sont sauvegardés. Dans une version future, le type d'identifiant basé sur la clé Web JSON (JWKS) sera également pris en charge.
• ID client (champ en lecture seule) - L'ID client généré automatiquement fait partie de vos informations d'identification client OAuth 2.0, utilisées pour authentifier les demandes à l'API CCW. L'ID Client est une chaîne aléatoire unique qui commence par "CCW" + votre préfixe client. Pour copier l'ID client, cliquez sur le bouton Copier à droite du champ.
• Utilisateur API - Choisissez un utilisateur API prédéfini (utilisateur client, MSP ou fournisseur) en fonction de la catégorie d'application que vous avez sélectionnée.

• Portées - Chaque API CCW nécessite une portée ou un point de destination spécifique. API actuellement disponibles avec une portée :
  • Candidats - en tant que ccw.candidates
  • Travailleurs temporaires - en tant que ccw.contingent_workers

Cliquez sur Enregistrer. Votre secret client est généré et affiché dans une bannière verte. Copiez/collez le secret du client et stockez-le dans un endroit sécurisé avant de fermer la bannière en cliquant sur le X.

Afficher vos applications

Si vous ou d'autres membres de votre organisation avez déjà créé des applications, une grille répertoriant vos applications existantes s'affiche lorsque vous accédez à Integration Toolkit > API Consumer Apps.

La colonne État indique si une application est active ou inactive. Cliquez sur les trois points à droite de la colonne État pour modifier l'application sur cette ligne. Pour les applications inactives, l'option Supprimer l'application est également disponible.

S'il existe une longue liste d'applications, vous pouvez rechercher des noms ou des catégories d'applications, ainsi que des utilisateurs (répertoriés dans la colonne Créé par), des dates (répertoriées dans les colonnes Date de création et Dernière modification), etc. Il suffit de taper dans la zone de recherche et de cliquer sur l'icône de la loupe pour affiner les résultats.

Rôles et droits

De nouveaux droits d'accès déterminent si un utilisateur peut accéder à Integration Toolkit > API Consumer Apps pour afficher des applications existantes, et/ou créer (enregistrer) une ou plusieurs nouvelles applications et gérer les informations d'identification :

• Integration Toolkit > API Consumer Apps > View API Client App - permet d'accéder à la liste des applications API Consumer. Désactivé par défaut.
• Integration Toolkit > API Consumer Apps > Manage API Client App - permet d'accéder à la création et à la gestion des applications API Consumer. Désactivé par défaut.