Base de connaissances – Intégration de logiciels via l’API

 

Dans cet article, vous en apprendrez plus sur les thèmes suivants :

  1. Documentation interactive de l’API
  2. Gestion de vos accès personnels
  3. Gestion des raccourcis de votre compte
  4. Autorisation des utilisateurs à accéder aux fonctionnalités de l’API

 

Intégration de logiciels via l’API

PlanRadar fournit une API (interface de programmation) et des Webhooks, afin d’intégrer un logiciel tiers ou un logiciel personnalisé à votre compte PlanRadar.

L’utilisation de l’API requiert des connaissances en matière de développement de logiciels ; une équipe de développement est donc nécessaire pour configurer l’API. Malheureusement, PlanRadar n’est pas en mesure de fournir un développement de logiciel personnalisé pour le compte de ses clients.

 

Documentation interactive de l’API

Avant de poursuivre, vous devez vous assurer d’avoir les autorisations nécessaires pour accéder aux fonctionnalités de l’API. Vous pouvez ensuite accéder à la documentation de l’API via Paramètres > Documentation de l’API :

 

Vous pouvez tester directement tous les points terminaux. Pour certains terminaux, vous devez spécifier un ID de projet ou de tâche que vous pouvez généralement trouver et copier à partir de l’URL lorsque vous visualisez le projet ou la tâche spécifique.

Vous aurez également la possibilité de copier et coller une commande curl et de tester l’API sur le shell de commande. Cependant, vous aurez besoin d’un accès qui est décrit dans la section suivante.
 

Gestion de vos accès personnels

Vous pouvez utiliser vos accès personnels pour permettre à des logiciels externes de s’authentifier auprès de nos serveurs lors de l’utilisation d’une API.

Avant de procéder, assurez-vous que vous disposez des autorisations nécessaires pour accéder aux fonctionnalités de l’API. Vous pouvez créer et gérer vos accès personnels sous Paramètres > Profil > Accès personnels.

 

Ces accès sont uniques pour chaque utilisateur. Vous ne devez les partager avec personne d’autre et devez les manipuler avec précaution. Toute personne en possession d’un accès pourrait potentiellement accéder à votre compte et agir en votre nom.

 

Par défaut, le taux maximum est de 30 demandes/minute. Pour augmenter cette limite, veuillez contacter [email protected].
 

Gestion des raccourcis de votre compte

Les webhooks permettent à des logiciels externes de réagir à des événements qui se produisent dans PlanRadar tels que “tâche créé”, “tâche mise à jour”, “photo jointe”, etc. Vous pouvez créer et gérer des webhooks sous Paramètres > Compte > Webhooks.

Ce paramètre n’est accessible qu’aux titulaires d’un compte.

 

Cliquez sur “Ajouter un nouveau Webhook”. Vous pourrez alors choisir les événements dont votre logiciel externe souhaite être informé.

 

Authentication:
Ici, vous configurez la manière dont nous pouvons nous authentifier auprès de votre serveur. Actuellement, nous supportons l'”Authentification HTTP de base” avec nom d’utilisateur et mot de passe.

 

En-têtes:
Si vous souhaitez fournir des champs d’en-tête supplémentaires pour votre service, vous pouvez les configurer ici. Pour les mots de passe ou autres informations confidentielles, nous offrons la possibilité de masquer la valeur dans l’interface utilisateur. Si vous choisissez de la masquer, vous ne pourrez pas la rappeler dans l’interface utilisateur après avoir sauvegardé votre webhook, pour des raisons de sécurité.

 

Accorder aux utilisateurs la permission d’accéder aux fonctionnalités de l’API

Les pages de documentation de l’API et les accès personnels ne peuvent être consultées qu’avec les autorisations appropriées du client. Les titulaires de compte se verront automatiquement accorder l’accès à la documentation de l’API.

Pour accorder à d’autres utilisateurs internes les autorisations appropriées, allez dans Gestion des utilisateurs > Utilisateurs, puis modifiez ou créez un nouvel utilisateur interne et cochez l’autorisation “Accès à l’API”.

 

Invalidation des accès d’autres utilisateurs

Vous pouvez supprimer les accès créés par d’autres utilisateurs internes. Pour cela, vous devez d’abord être autorisé à gérer les utilisateurs.

Pour supprimer un jeton d’accès créé par un utilisateur, allez à Gestion des utilisateurs > Utilisateurs via la barre de navigation. Sélectionnez ensuite l’utilisateur interne dont vous souhaitez supprimer l’accès. Vous verrez les accès créés par les utilisateurs sur le côté droit, et à partir de là, vous pouvez les supprimer.

 

Remarque : les jetons d’accès créés par le titulaire du compte ne peuvent pas être supprimés par les autres utilisateurs. Seul le titulaire du compte peut supprimer ses propres jetons d’accès en allant dans Paramètres > Profil > Jeton d’accès personnel.

Revenir au sommaire.