Aperçu de l'API ouverte

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 automatismes personnalisés et des intégrations 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

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

1. Cliquez sur Settings
2. Cliquez sur Documentation de l'API
3. Entrez votre mot de passe
4. Cliquez sur Confirmer
   

   

5. Sélectionnez la fonctionnalité ****dont vous voulez montrer les API
   

   

6. Une liste de toutes les API liées à cette fonctionnalité s'affiche
   

   

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" : "projets",
      "attributs" : {
        "id" : "aqbqod",
        "name" : "Votre nom de projet",
        "homepage" : "",
        "country" : null,
        "projectnumber" : null,
        "description" : null,
        "city" : null,
        "code postal" : null,
        "street" : null,
        "author-id" : "pxpp",
        ...
      }
    }
  }

Concepts de base de l'API

Découvrez les concepts fondamentaux qui sous-tendent nos API. Pour en savoir plus, consultez le site Core API Concepts.

Tutoriels API

Découvrez des tutoriels étape par étape sur la façon d'utiliser nos API dans les domaines suivants :

Tutoriels API pour les points de terminaison utilisateur

Tutoriels API pour les points de terminaison des projets

Tutoriels API pour Tâches Endpoints

Tutoriels API pour les points de terminaison des documents

Tutoriels API pour Schedule Endpoints

Évolution de l'API

Consultez les dernières mises à jour et modifications apportées à nos API. Pour en savoir plus, consultez API Changelog.