PlanningPME API - Intégration personnalisée

PlanningPME fournit une API d'intégration personnalisée, dédiée à la synchronisation des données PlanningPME avec les applications tierces.

Ce document répond aux questions suivantes :

Pourquoi une API d'intégration "personnalisée" ?
Comment fonctionne l'API d'intégration personnalisée ?
Quels sont les modèles d'intégration prêts à l'emploi ?
Comment créer un nouveau modèle d'intégration ?
Comment interroger l'API d'intégration personnalisée ?

Pourquoi une API d'intégration "personnalisée" ?

Synchroniser les données entre différentes composantes d'un système d'information est une problématique courante. Différents services doivent pouvoir fonctionner avec la même information, mais personne ne veut gérer cette information à plusieurs endroits.
PlanningPME fournit tous les outils permettant d'échanger ses données avec le monde extérieur.

En pratique, il n'est pas toujours possible d'adapter un export de données aux contraintes du système qui va les utiliser. Et vous n'avez peut-être simplement pas envie d'adapter vos données à un nouveau modèle pour les échanger avec une autre application.
PlanningPME fournit toute la flexibilité nécessaire pour l'acquisition et la présentation de données à travers ses modèles d'intégration personnalisée.

Cette flexibilité s'applique à vos applications propriétaires comme aux applications les plus répandues, du type CRM (SalesForce, Microsoft Dynamics...) ou ERP (SAP, Oracle...).
PlanningPME travaille à l'implémentation continue de modèles d'échange spécifiques aux applications les plus utilisées du marché.

En résumé, l'API d'intégration personnalisée présente deux avantages de taille par rapport à l'API PlanningPME classique :
  • elle fonctionne avec des modèles adaptés à votre structure de données,
  • elle autorise la synchronisation de masse en une seule requête, évitant ainsi les limitations de quota.

Comment fonctionne l'API d'intégration personnalisée ?

La définition de modèles autorise toute la flexibilité nécessaire à l'acquisition et la présentation de données.
Les modèles sont de deux types : modèle d'import pour importer des données vers PlanningPME, et modèle d'export pour exporter des données de PlanningPME.
Un modèle d'import définit la correspondance entre les champs reçus de l'extérieur et les champs PlanningPME, tandis qu'un modèle d'export définit la correspondance entre les champs exportés de PlaningPME et ceux de l'application cible.
Un modèle définit également le formatage ou le couplage des données, ainsi que des valeurs et traitements par défaut.

Exemple de modèle d'import

<In>
	<Type Name="Customer" ShouldInsert="true" ShouldUpdate="true">
		<Default Field="Type" Value="1026" />
	</Type>
	<Property Name="Nom usage" Type="Customer" Field="LastName" />
	<Property Name="Téléphone mobile" Type="Customer" Field="Mobile" />
	<Property Name="Email" Type="Customer" Field="Email" />
	<Property Name="ID_DOSSIER" Type="Customer" Field="_IDDOSSIER" />
</In>

Dans ce modèle, on définit un import de client pouvant insérer ou mettre à jour des données.
On définit une valeur par défaut pour le type de client (tous les clients sont des particuliers).
On définit enfin la correspondance entre les champs reçus et les champs PlanningPME (qu'il s'agisse de champs personnalisés ou de champs génériques).

Dès sa mise en place sur votre API, ce modèle vous permet d'importer des données sans plus vous soucier du schéma PlanningPME.

Modèles d'intégration prêts à l'emploi

Les modèles d'intégration prêts à l'emploi suivants sont disponibles dans toute installation :

Cette liste est amenée à s'étoffer au fur et à mesure des demandes d'intégration vers des applications tierces connues ou de besoins génériques.

Nouvelle intégration personnalisée

Exposez votre demande spécifique à notre support afin qu'il l'étudie et génère un nouveau modèle entièrement adapté à votre cas (des frais de développement peuvent être établis selon la complexité de l'intégration).

Des modèles personnalisés sont fréquemment implémentés pour les clients qui veulent faire de la synchronisation de masse, sans risquer d'atteindre les limitations de quotas d'usage de leur API.

La plupart du temps les clients veulent aussi simplement utiliser leur propre modèle de données pour échanger avec PlanningPME. C'est ce qu'autorise l'API d'intégration personnalisée, quel que soit le niveau de complexié du modèle d'origine.
Il arrive par ex qu'une même entité du modèle d'origine corresponde à différentes entités dans le modèle PlanningPME. L'intégration personnalisée permet d'éclater une même ligne sur plusieurs entités, ce qui facilite grandement ce genre de synchronisations.

Quelle que soit l'intégration à prévoir, notre réponse sera adaptée à vos besoins et à votre enrionnement.
Nous serons heureux de travailler avec vous à son élaboration.

N'hésitez pas à nous contacter pour plus d'information ou pour spécifier votre intégration.

Interroger l'API d'intégration personnalisée

L'API d'intégration personnalisée fait partie de l'API PlanningPME, veuillez vous référer à la documentation développeur pour connaître les bases d'interaction avec l'API.

Modèles d'integration

Les modèles d'intégration personnalisée installés sur votre API peuvent être récupérés au moyen de l'appel suivant.

GET /votre_marque/api/integration/templates HTTP/1.1
Host: api.planningpme.com
X-APPKEY: votre_clé
Authorization: votre_jeton

Cette méthode renvoie les modèles d'import et d'export de données installés ainsi que leur descriptif détaillé.

Export basé sur un modèle spécifique

Les modèles d'export renvoient les données trouvées dans la base PlanningPME.

GET /votre_marque/api/integration/votre_modele?since=20181231045803 HTTP/1.1
Host: api.planningpme.com
X-APPKEY: votre_clé
Authorization: votre_jeton

Le paramètre "since" (optionnel) permet d'indiquer au modèle que seul les éléments créés et modifiés après cette date (format yyyyMMddHHmmss) doivent être exportés.
En l'absence du paramètre tous les éléments répondant au modèle demandé sont renvoyés.

Import basé sur un modèle spécifique

Les modèles d'import (notés "in" dans les descriptifs) réceptionnent des données à insérer ou modifier dans la base PlanningPME.

POST /votre_marque/api/integration/votre_modele HTTP/1.1
Host: api.planningpme.com
X-APPKEY: votre_clé
Authorization: votre_jeton

{
	simulate: false,
	verbose: false,
	stopOnError: false,
	model: {
		...
	}
}

Les paramètres d'exécution d'un import (en plus des correspondances définies en amont dans le modèle) sont les suivants :

  • simulate (booléen, par défaut à false) : permet de simuler l'import, à true la réponse détaillera toutes les insertions et modifications qui auraient été appliquées en base autrement, vous permettant ainsi de valider un modèle d'import avant de l'exécuter sur vos données de production,
  • verbose (booléen, par défaut à false) : indique si la méthode doit retourner le détail des traîtements opérés,
  • stopOnError (booléen, par défaut à false) : à true l'import s'arrêtera dès la première erreur rencontrée, à false l'import continuera avec les éléments suivants,
  • model : objet JSON contenant les données à importer, ces données doivent être structurées selon le modèle spécifique défini en amont.

Import client

POST /votre_marque/api/integration/client-import HTTP/1.1
Host: api.planningpme.com
X-APPKEY: votre_clé
Authorization: votre_jeton

{
	simulate: false,
	verbose: false,
	stopOnError: false,
	model: {
		...
	}
}

Import projet

POST /votre_marque/api/integration/project-import HTTP/1.1
Host: api.planningpme.com
X-APPKEY: votre_clé
Authorization: votre_jeton

{
	simulate: false,
	verbose: false,
	stopOnError: false,
	model: {
		...
	}
}