PlanningPME 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...

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.

Basique	Milli	Micro	Nano	Plus
2 000 requ�tes / heure	3 000 requ�tes / heure	5 000 requ�tes / heure	8 000 requ�tes / heure	+ 10 000 requ�tes / heure
Gratuit	15 � / mois	30 � / mois	50 � / mois	Nous consulter

Ex : mon programme fait 4 500 requ�tes en moins d'une heure avec la m�me AppKey, je suis averti par e-mail 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.

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.