Aller au contenu principal

Inscrire une application externe

Objectif​

Inscrire un système externe (une intégration, un service ou un middleware) pour qu’il puisse appeler les API Parsware avec ses propres informations d’identification.

Prérequis​

  • Vous êtes connecté au Centre de contrôle d’administration en tant qu’administrateur de la plateforme.
  • Vous savez de quelles étendues le système externe a besoin (par exemple, l’accès en lecture aux données d’application).

Étapes​

  1. Ouvrez la page Inscriptions d’applications depuis la navigation de gauche.
  2. Saisissez un nom d’application qui identifie le système externe.
  3. Sélectionnez dans la liste les étendues dont l’application a besoin. Chaque étendue accorde un type d’accès précis.
  4. Choisissez les rôles de sécurité que l’application détient, le cas échéant. Laisser ce champ vide correspond au privilège minimal : l’application peut appeler la plateforme sans toucher à aucun enregistrement. Un script d’API personnalisée s’exécute en tant que l’application, sous ces rôles — une application dont les scripts lisent ou écrivent des enregistrements a donc besoin exactement du rôle qui le permet, et ce rôle ne devrait recevoir d’autorisations que dans les environnements que l’application dessert.
  5. Sélectionnez Inscrire l’application.
  6. Un panneau affiche le nouvel ID client et le Secret client. Copiez le secret client maintenant — il n’est affiché qu’une seule fois et ne peut pas être récupéré par la suite.

Ce qui se passe en coulisses​

L’application externe devient un client d’API inscrit. Elle s’authentifie avec son ID client et son secret pour obtenir un jeton d’accès de courte durée, puis appelle les API Parsware avec ce jeton. Le jeton est limité exactement aux étendues que vous avez accordées, nomme votre locataire et porte les rôles que vous avez choisis — c’est ce qui détermine les enregistrements qu’elle peut atteindre.

Dépannage​

  • « Scope … can only be granted by the platform operator. » — parsware.provision et parsware.portals.serve appartiennent aux serveurs de l'opérateur de la plateforme (le site web, l'hôte des portails) et ne figurent pas dans votre liste. Aucune de vos applications n'en a besoin.
  • Une application révoquée a encore répondu un moment. La révocation l'empêche aussitôt d'obtenir un nouveau jeton, mais chaque service vérifie lui-même le jeton qu'elle détient déjà, valable jusqu'à son expiration, dans l'heure. Pour la couper aussitôt, retirez aussi les autorisations de son rôle dans cet environnement : elles sont vérifiées à chaque appel.
  • « L’étendue … n’est pas une étendue connue de la plateforme. » — une étendue demandée ne figure pas dans le catalogue. Sélectionnez uniquement des étendues de la liste affichée.
  • « Le rôle … n’existe pas dans ce locataire. » — un rôle choisi a été supprimé avant l’enregistrement de l’inscription. Rouvrez le panneau et choisissez de nouveau.
  • « Au moins une étendue doit être accordée. » — sélectionnez au moins une étendue avant d’inscrire l’application.
  • Vous avez perdu le secret client — le secret ne peut pas être récupéré. Révoquez l’inscription et inscrivez de nouveau l’application pour obtenir un nouveau secret.

Scénarios associés​

  • Révoquer une application externe.