API ouvertes – PlanRadar HelpCenter

Vue d'ensemble

PlanRadar fournit des API REST sécurisées qui sont ouvertes à tous les clients pour leurs propres intégrations. En outre, PlanRadar fournit également PlanRadar Connect pour créer des automatisations et des intégrations personnalisées avec des applications tierces sans codage. Pour en savoir plus, consultez PlanRadar Connect.

L'API REST comporte des URL orientées ressources, accepte des corps de demande codés en formulaire, renvoie des réponses codées en JSON et utilise des codes de réponse HTTP standard ainsi que l'authentification.

Accès et autorisations

Open APIs n'est disponible que pour les comptes Pro et Enterprise. Pour en savoir plus, consultez le site Prix et abonnement.

Pour utiliser les API ouvertes, vous devez être un utilisateur interne disposant de l'autorisation "Accès API". Pour en savoir plus, consultez Permissions.

Utiliser des API ouvertes

Lorsque vous utilisez les API, vous pouvez envoyer jusqu'à 30 demandes par minute. Le dépassement de cette limite entraîne la désactivation de votre jeton d'autorisation pendant 5 minutes. En cas d'exigences particulières, veuillez contacter notre équipe d'assistance.

Autorisation d'accès à l'API

Lorsque vous consommez une API, vous devez ajouter la clé d'autorisation en tant que valeur d'en-tête "X-PlanRadar-API-Key". La clé d'autorisation peut être obtenue en générant Personal Access Tokens et en les utilisant pour authentifier vos demandes d'API.

API disponibles

Cliquez sur Settings
Cliquez sur Documentation de l'API
Entrez votre mot de passe
Cliquez sur Confirmer
Sélectionnez la fonctionnalité dont vous voulez montrer les API
Une liste de toutes les API liées à cette fonctionnalité s'affiche

Nous travaillons actuellement à la mise à niveau de toutes nos API vers la version 2. Nous vous recommandons d'utiliser les API v2 si elles sont disponibles. Les API V2 sont plus rapides, plus robustes et plus flexibles que les API v1.

Exemple de demande API

Voici un exemple d'utilisation des API pour appeler les détails d'un projet :

URL DE L'API :

GET /api/v1/{customer_id}/projets

Corps de la demande :

{
 "data" : {
 "attributes" : {
 "name" : "Nom de votre projet"
 }
 }
}

Corps de la réponse :

{
 "data" : {
 "id" : "aqbqod",
 "type" : "projects",
 "attributes" : {
 "id" : "aqbqod",
 "name" : "Nom de votre projet",
 "homepage" : "",
 "country" : null,
 "projectnumber" : null,
 "description" : null,
 "city" : null,
 "zipcode" : null,
 "street" : null,
 "author-id" : "pxpp",
...
   }
 }
}

Articles connexes

Configuration des Webhooks