PlanningPME API - Integración personalizada
PlanningPME proporciona una API de integración personalizada dedicada a sincronizar los datos de PlanningPME con aplicaciones de terceros.
Este documento responde a las siguientes preguntas:
¿Por qué una API de integración "personalizada"?¿Cómo funciona la API de integración personalizada?
¿Cuáles son las plantillas de integración listas para usar?
¿Cómo crear un nuevo modelo de integración?
¿Cómo consultar la API de integración personalizada?
¿Por qué una API de integración "personalizada"?
La sincronización de datos entre diferentes componentes de un sistema de información es un problema común. Los diferentes servicios deben poder trabajar con la misma información, pero nadie quiere administrar esta información en más de un lugar.
PlanningPME proporciona todas las herramientas para intercambiar sus datos con el mundo exterior.
En la práctica, no siempre es posible adaptar una exportación de datos a las restricciones del sistema que los utilizará. Y es posible que no desee adaptar sus datos a un nuevo modelo para intercambiar con otra aplicación
PlanningPME proporciona toda la flexibilidad necesaria para la adquisición y presentación de datos a través de sus modelos de integración personalizados.
Esta flexibilidad se aplica a sus aplicaciones propietarias, así como a las aplicaciones más extendidas, como CRM (SalesForce, Microsoft Dynamics ...) o ERP (SAP, Oracle ...).
PlanningPME trabaja en la implementación continua de modelos de intercambio específicos para las aplicaciones más utilizadas en el mercado.
- Funciona con plantillas adaptadas a su estructura de datos,
- Permite la sincronización masiva en una sola consulta, evitando así restricciones de cuota.
¿Cómo funciona la API de integración personalizada?
La definición del modelo permite toda la flexibilidad necesaria para la adquisición y presentación de datos.
Hay dos tipos de plantillas: importar plantilla para importar datos a PlanningPME y exportar plantilla para exportar datos de PlanningPME.
Una plantilla de importación define la correspondencia entre los campos recibidos desde el exterior y los campos de PlanningPME, mientras que una plantilla de exportación define la correspondencia entre los campos exportados de PlaningPME y los de la aplicación de destino.
Una plantilla también define el formato o el acoplamiento de los datos, así como los valores y el procesamiento predeterminados.
Muestra de plantilla de importación
<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>
En este modelo, definimos una importación de cliente que puede insertar o actualizar datos.
Se define un valor predeterminado para el tipo de cliente (todos los clientes son particulares)
Finalmente, definimos la correspondencia entre los campos recibidos y los campos de PlanningPME (ya sea campos personalizados o campos genéricos).
Tan pronto como se implementa en su API, este modelo le permite importar datos sin preocuparse por el esquema PlanningPME.
Modelos de integración listos para usar
Los siguientes modelos de integración listos para usar están disponibles en cualquier instalación:
- Importación de cliente (desde la versión 4.1.1.116)
- Importación de proyecto (desde la versión 4.1.1.116)
Esta lista se ampliará como solicitudes de integración a aplicaciones de terceros conocidas o necesidades genéricas.
Nueva integración personalizada
Exponga su solicitud específica a nuestro soporte para que la estudie y genere un nuevo modelo completamente adaptado a su caso (los costos de desarrollo pueden establecerse de acuerdo con la complejidad de la integración).
Las plantillas personalizadas se implementan con frecuencia para los clientes que desean realizar una sincronización masiva sin el riesgo de alcanzar las limitaciones de las cuotas de uso de sus API.
La mayoría de las veces, los clientes simplemente quieren usar su propio modelo de datos para interactuar con PlanningPME. Esto es lo que permite la API de integración personalizada, independientemente del nivel de complejidad del modelo original.
Sucede, por ejemplo, que la misma entidad del modelo original corresponde a diferentes entidades en el modelo PlanningPME. La integración personalizada permite dividir la misma línea en varias entidades, lo que facilita enormemente este tipo de sincronización
Independientemente de la integración que se espere, nuestra respuesta se adaptará a sus necesidades y su inscripción.
Estaremos encantados de trabajar con usted en su desarrollo.
No dude en contactarnos para obtener más información o para especificar su integración.
Consulta la API de integración personalizada
La API de integración personalizada es parte de la API de PlanningPME, consulte documentación del desarrollador para conocer las bases de interacción con la API.
Modelos de integración
Las plantillas de integración personalizadas instaladas en su API se pueden recuperar utilizando la siguiente llamada.
GET /su_marca/api/integration/templates HTTP/1.1 Host: api.planningpme.com X-APPKEY: tu_clave Authorization: tu_token
Este método devuelve las plantillas de importación y exportación de datos instaladas y su descripción detallada.
Exportación basada en un modelo específico.
Las plantillas de exportación devuelven los datos encontrados en la base de datos PlanningPME.
GET /votre_marque/api/integration/su_plantilla?since=20181231045803 HTTP/1.1 Host: api.planningpme.com X-APPKEY: tu_clave Authorization: tu_token
El parámetro "desde" (opcional) permite indicar al modelo que solo se deben exportar los elementos creados y modificados después de esta fecha (formato yyyyMMddHHmmss).
En ausencia del parámetro se devuelven todos los elementos correspondientes al modelo solicitado.
Importación basada en un modelo específico.
Las plantillas de importación (indicadas "en" en las descripciones) reciben datos que se insertarán o modificarán en la base de datos PlanningPME.
POST /su_marca/api/integration/su_plantilla HTTP/1.1
Host: api.planningpme.com
X-APPKEY: tu_clave
Authorization: tu_token
{
simulate: false,
verbose: false,
stopOnError: false,
model: {
...
}
}
Los parámetros de ejecución de una importación (además de las coincidencias definidas en sentido ascendente en el modelo) son los siguientes:
- simular (booleano, por defecto es falso): simula la importación, verdadera la respuesta detallará todas las inserciones y cambios que se habrían aplicado a la base de datos, permitiéndole validar un modelo de importación antes de ejecutarlo
- verboso (booleano, por defecto a falso): indica si el método debe devolver los detalles de las operaciones realizadas,
- stopOnError (booleano, predeterminado en falso): verdadero la importación se detendrá tan pronto como se encuentre el primer error, en falso la importación continuará con los siguientes elementos,
- modelo: objeto JSON que contiene los datos a importar, estos datos deben estructurarse de acuerdo con el modelo específico definido en sentido ascendente.
Importación del cliente
POST /su_marca/api/integration/client-import HTTP/1.1
Host: api.planningpme.com
X-APPKEY: tu_clave
Authorization: tu_token
{
simulate: false,
verbose: false,
stopOnError: false,
model: {
...
}
}
Importacion de proyecto
POST /su_marca/api/integration/project-import HTTP/1.1
Host: api.planningpme.com
X-APPKEY: tu_clave
Authorization: tu_token
{
simulate: false,
verbose: false,
stopOnError: false,
model: {
...
}
}