PlanningPME API

Ce document vous renseignera sur :

Définition et rôle : qu'est-ce qu'une API ?

Une API, c'est une Application Programming Interface, en français une Interface de Programmation d'Application. Expliquons chacun de ces termes pour mieux comprendre :

  • - "Application" : une application est un service accessible par un humain ou un programme informatique.
    Ex : Facebook est une application de réseau social, Spotify est une application de streaming audio, PlanningPME une application de planning.
  • - "Programming" : un programme est un ensemble de fonctions informatiques écrites par un développeur qui exécute des tâches à sa place.
    Ex : si je veux transformer des adresses postales en coordonnées géographiques, je peux le faire à la main, ou je peux écrire un programme pour le faire à ma place.
  • - "Interface" : une interface fait la jonction entre deux choses, ici entre une application et les programmes qui l'utilisent. Elle définit ce que le programme peut demander à l'application, elle transmet les demandes du programme à l'application, et les réponses de l'application au programme.


Au même titre qu'une télécommande est l'interface utilisée par un téléspectateur pour programmer son téléviseur, une API est l'interface utilisée par un programmeur pour interagir avec une application.

L'API PlanningPME est donc l'interface de l'application PlanningPME, elle tient un rôle majeur.
En tant que point de passage obligatoire, elle est en mesure d'identifier les accès, sécuriser les transmissions, contrôler la volumétrie des demandes, etc...

Volumétrie : quelles sont les limites d'appel de l'API PlanningPME ?

Chaque installation d'une API PlanningPME dispose d'une clé d'utilisation, appelée AppKey. Elle authentifie un programme (ou ensemble de programmes) auprès de l'API.

Une même AppKey dispose par défaut d'une volumétrie maximale de 2 000 requêtes par heure.
Au delà de cette limite, le propriétaire de la clé sera notifié du dépassement, et son plan ajusté selon la grille tarifaire suivante.

BasiqueMilliMicroNanoPlus
2 000 requêtes / heure3 000 requêtes / heure5 000 requêtes / heure8 000 requêtes / heure+ 10 000 requêtes / heure
Gratuit15 € / mois30 € / mois50 € / moisNous consulter

Ex : mon programme fait 4 500 requêtes en moins d'une heure avec la même AppKey, je suis averti par email que mon quota horaire a atteint la tranche "Micro", et que je serai facturé de 50 € en fin de mois.

Au-delà de 10 000 requêtes / heure un accord préalable est obligatoire.
Toute clé dépassant ce quota d'usage maximal sans autorisation sera immédiatement désactivée.

Vocation : quelles sont les différences entre l'API standard et l'API personnalisée ?

L'API PlanningPME comporte deux types d'opérations.

L'API standard permet de faire toutes les opérations unitaires de base sur l'application PlanningPME.

Ex : ajouter/modifier/supprimer un événement, mettre à jour un client/projet/ressource, modifier les droits d'un groupe, changer une option etc...

L'ensemble de ces opérations est décrit dans la documentation interactive de l'API PlanningPME.

L'API personnalisée permet de faire des opérations de masse sur l'application PlanningPME, et de paramétrer ces opérations au sein de modèles d'intégration.

Ex : j'envoie les infos à jour de mes 25 000 clients à l'API, en une seule requête et selon un format pré-défini et personnalisé, l'API se charge de mettre à jour l'ensemble de mes clients déjà en base, d'ajouter les nouveaux, ou encore supprimer les clients obsolètes.

Ces opérations, appelées aussi opérations d'intégration (méthode "integration" de l'API), sont définies au sein de modèles d'intégration.

Il est fortement conseillé de recourir à l'API personnalisée pour implémenter toute synchronisation de masse (type client/ressource/projet par ex), afin de ne pas dépasser les limites d'utilisation de votre clé. Une synchronisation réalisée au moyen de l'API personnalisée coûte 1 seule requête, peu importe le nombre d'éléments mis à jour dans cette requête.

Consultez la documentation de l'API d'intégration personnalisée pour plus de détail.