Aller au contenu

Créer des clés API

Pour permettre à une intégration d’accéder à Yesplan, vous devez créer une clé API. Vous pouvez toutefois gérer les intégrations et les clés API de différentes façons. Cette page vous présente quelques astuces.

Sécurité§

Une clé API fonctionne comme un mot de passe pour l’API :

  • Toute personne disposant de la clé API peut accéder à votre API, ainsi qu’à toutes les informations enregistrées dans votre installation, et pourra même modifier certains champs si les droits d’accès sont configurés de manière à le permettre. Traitez donc la clé avec le même soin qu’un mot de passe et ne la publiez jamais dans un espace public.
  • Ne créez pas de clé API pour un utilisateur qui est administrateur.
  • Ne partagez pas les clés avec d’autres personnes (hormis le créateur de votre intégration, bien entendu).
  • Supprimez chaque clé API que vous soupçonnez avoir été divulguée.
  • Réfléchissez bien avant de supprimer une clé API : si la clé est utilisée par une intégration, cette intégration ne fonctionnera plus correctement. Dans ce cas, créez immédiatement une nouvelle clé API pour l’intégration concernée et communiquez la nouvelle clé à l’administrateur de l’intégration.

Attention

Les clés API sont de véritables mots de passe et sont donc strictement personnels. Chaque personne disposant d’une telle clé peut accéder à Yesplan par l’intermédiaire de l’API.

Utilisateurs des clés API§

Vous pouvez créer une clé API pour n’importe quel utilisateur de Yesplan, mais n’oubliez pas que la clé d’une intégration donnée est associée à un utilisateur spécifique :

  • L’intégration n’aura plus accès à Yesplan si vous supprimez cet utilisateur.
  • Vous devez veiller à configurer correctement les droits d’accès de l’utilisateur, ainsi que de l’intégration.
  • Vous ne pourrez jamais faire de cet utilisateur un administrateur.

Voilà pourquoi nous recommandons de créer un utilisateur spécifique pour chaque intégration, que vous n’utiliserez que pour cette intégration. Vous éviterez ainsi de supprimer accidentellement l’utilisateur ou de lui conférer des droits d’administrateur et vous appliquerez plus facilement les droits d’accès adéquats à chaque intégration. Exécutez à cet effet les étapes suivantes :

Créer l’utilisateur§

Créez un nouvel utilisateur et attribuez-lui le modèle des droits d’accès adéquat :

  • Accédez à « Paramètres du système » > « Utilisateurs » > « Utilisateurs ».

  • Cliquez sur « Ajouter un utilisateur » et complétez les champs :

    • Nom d’utilisateur : Le nom (de société) de votre intégration, par exemple « Site internet ».
    • Mot de passe : Yesplan vous aide à choisir un mots de passe fort.
    • Nom : Le nom (de société) de votre intégration, par exemple « Site internet ».
    • E-mail : N’inscrivez rien ici, puisque cet utilisateur ne sera utilisé que pour l’intégration.
    • Créer une ressource associée : Cochez cette case à cocher.
    • Créer un contact associé : Décochez cette case à cocher.

Astuce

Cet utilisateur n’étant utilisé que pour la clé API de l’intégration, il est inutile de lui associer un contact.

  • Après la création de l’utilisateur, vous pouvez continuer de le configurer :

    • Groupes d’utilisateurs : Facultatif.
    • Groupe principal : Facultatif.
    • Modèles des droits d’accès : « Autorisation générale » ou « Général », selon votre installation.
    • Administrateur : Ne doit jamais être coché.

Astuce

  • Vous pouvez aussi créer un groupe d’utilisateurs pour cet utilisateur ou vous pouvez l’assigner à un groupe d’utilisateurs existant si cela correspond à votre manière de travailler dans votre installation. Ce n’est toutefois pas obligatoire.
  • Nous déconseillons d’accorder l’accès aux intégrations par l’intermédiaire d’un utilisateur disposant de droits d’administrateur.

Attribuer les droits d’accès§

Attribuez les droits d’accès à l’utilisateur pour l’intégration :

  • Accédez à « Paramètres du système » > « Utilisateurs » > « Modèles des droits d’accès ».
  • Cliquez sur « Afficher les droits » pour le modèle général. Celui-ci est souvent nommé « Général » ou « Autorisation générale ». Il s’agit du modèle utilisé pour définir les droits d’accès accordés aux groupes d’utilisateurs.
  • Cliquez sur « Ajouter un utilisateur ou un groupe d’utilisateurs » en bas de la page, sélectionnez l’utilisateur que vous venez de créer (ou le groupe d’utilisateurs auquel il appartient) et cliquez sur « Ajouter ».
  • Dans cette ligne, sélectionnez uniquement les droits nécessaires pour l’intégration :
    • Si l’intégration doit pouvoir retrouver des événements, mais sans avoir la possibilité de les modifier, sélectionnez uniquement « Consulter » dans la colonne « Événements ».
    • Si l’intégration doit pouvoir retrouver et modifier des ressources, sélectionnez « Consulter » et « Modifier » dans la colonne « Ressources ».

Astuce

Les exigences en matière de droits d’accès varient d’une intégration à l’autre. Concertez-vous au besoin avec le créateur de votre intégration ou avec votre Customer Success Manager chez Yesplan pour savoir quels droits d’accès spécifiques sont nécessaires pour l’intégration.

Masquer les ressources associées§

Lors de la création d’un utilisateur, Yesplan crée automatiquement une ressource portant le même nom. Cet utilisateur n’étant utilisé que pour la clé API de l’intégration, il est préférable de masquer la ressource associée, afin d’assurer qu’elle ne puisse être réservée.

  • Dans le menu de navigation, cliquez sur « Ressources ».
  • Utilisez la barre de recherche pour retrouver la ressource portant le nom de l’utilisateur que vous venez de créer. Dans notre exemple, il s’agissait de « Site internet ».
  • Cliquez droit sur la ressource adéquate dans la liste des résultats et choisissez « Afficher infos ».
  • Sous l’onglet « Droits d’accès », décochez toutes les cases à cocher de la colonne « Consulter ».

Remarque

Les administrateurs voient toujours toutes les ressources, même si le droit de « Consulter » a été désélectionné pour certaines ressources.

Créer une clé API§

Pour rendre accessible l’API, vous devez créer une clé API dans Yesplan et la communiquer au créateur de votre intégration :

  1. Accédez à « Paramètres du système » > « Intégrations » > « Clés API ».
  2. Sélectionnez l’utilisateur que vous venez de créer (par exemple « Site internet ») dans le menu déroulant en bas du tableau et cliquez sur « Ajouter ».
  3. L’utilisateur est ajouté au tableau. La valeur de la colonne « Clé » est la clé API permettant à l’intégration d’accéder à l’API de Yesplan.

Astuce

Consultez Gestion des clés API et le Webhooks API pour en savoir plus.

Onglet pour votre intégration§

Votre intégration continuera de fonctionner parfaitement, même si vous n’exécutez pas cette étape, mais nous recommandons de créer un onglet pour tous les champs de données personnalisées utilisés par l’intégration. Cela vous permet de retrouver dans Yesplan un bel aperçu, organisé par événement ou ressource, des données utilisées par une intégration externe.

Astuce

Pour en apprendre davantage sur :