PlanningPME API - Integração personalizada

PlanningPME fornece uma API de integração personalizada, para sincronizar os dados de PlanningPME com as aplicações de camadas.

Este documento responde às seguintes perguntas:

Porquê uma API de integração "personalizada"?
Como funciona a API de integração personalizada?
Que tipo de integração pode ser feita fora da caixa?
Como podemos ajudar com uma integração muito específica?
Como fazer um pedido de integração?

Porquê uma API de integração "personalizada"?

A sincronização de dados entre serviços é um assunto comum hoje em dia. Serviços diferentes podem requerer o mesmo dado, mas ninguém quer gerir estes dados duas vezes.
PlanningPME fornece as ferramentas para o intercâmbio de dados com o resto do sistema de informação.

Na prática, nem sempre é possível adaptar uma exportação de dados aos constrangimentos do sistema que os irá utilizar. E poderá não querer adaptar os seus dados a um novo modelo a partilhar com outra aplicação.
O PlanningPME proporciona-lhe esta flexibilidade para a aquisição e apresentação de dados com a API de integração personalizada.

Esta flexibilidade aplica-se às suas aplicações proprietárias, bem como às aplicações mais difundidas, tais como CRM (SalesForce, Microsoft Dynamics ...) ou ERP (SAP, Oracle ...).
PlanningPME trabalha na implementação contínua de modelos de intercâmbio específicos para as aplicações mais utilizadas no mercado.

Em resumo, a API de integração personalizada tem duas grandes vantagens sobre a traditional API:
  • funciona com modelos que são totalmente adaptados ao seu próprio modelo de dados,
  • permite a sincronização de massa numa única consulta, evitando assim restrições de quotas.

Como funciona a API de integração personalizada?

A definição do modelo permite toda a flexibilidade necessária para a aquisição e apresentação de dados.
Existem dois tipos de modelos: modelos de importação para importar dados para o PlanningPME, e modelos de exportação para exportar dados do PlanningPME.
Um modelo de importação define a correspondência entre os campos recebidos e os campos PlanningPME, enquanto que um modelo de exportação define a correspondência entre os campos exportados do PlanningPME e os da aplicação de destino.
Um modelo também define a formatação ou acoplamento de dados, bem como os valores por defeito e o processamento.

Modelo de modelo de importação de amostras

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

Neste modelo, definimos uma importação de cliente que pode inserir ou actualizar dados.
É definido um valor por defeito para o tipo de cliente (todos os clientes são indivíduos).
Finalmente, definimos a correspondência entre os campos recebidos e os campos PlanningPME (se campos personalizados ou campos genéricos).

Assim que for implementado no seu API, este modelo permite-lhe importar dados sem se preocupar com o esquema do PlanningPME.

Modelos de integração prontos a usar

Esses modelos prontos a usar estão disponíveis por defeito em cada instalação API:

Espera-se que esta lista cresça à medida que os pedidos de pedidos conhecidos de terceiros, ou para necessidades genéricas.

Implementação de casos específicos

Exponha o seu pedido específico ao nosso apoio para que o estude e gere um novo modelo inteiramente adaptado ao seu caso (os custos de desenvolvimento podem ser estabelecidos de acordo com a complexidade da integração).

Os templates personalizados são frequentemente implementados para clientes que desejam fazer uma sincronização em massa sem o risco de atingir as limitações de quota de utilização dos seus APIs.

Na maioria das vezes, os clientes também querem simplesmente utilizar o seu próprio modelo de dados para interagir com o PlanningPME. É isto que o API de integração personalizada permite, independentemente do nível de complexidade do modelo original.
Acontece, por exemplo, que a mesma entidade do modelo original corresponde a entidades diferentes no modelo PlanningPME. A integração personalizada torna possível dividir a mesma linha em várias entidades, o que facilita muito este tipo de sincronizações.

Qualquer que seja a integração a esperar, a nossa resposta será personalizada às suas necessidades e ao seu ambiente.
Teremos todo o prazer em trabalhar consigo no seu desenvolvimento.

Não hesite em contacte-nos para mais informações ou para especificar a sua integração.

Exemplos de pedidos de integração personalizados API

A API de integração personalizada faz parte do PlanningPME API, consulte por favor a documentação do desenvolvedor para os princípios básicos de interacção com o API.

Modelos de integração

Os modelos de integração personalizados instalados no seu API podem ser recuperados utilizando a chamada seguinte.

GET /a sua_marca/api/integration/templates HTTP/1.1
Host: api.planningpme.com
X-APPKEY: a sua_chave
Authorization: seu_token

Este método devolve os modelos de importação e exportação de dados instalados e a sua descrição detalhada.

Exportação com base num modelo específico

Os modelos de exportação devolvem os dados encontrados na base de dados PlanningPME.

GET /votre_marque/api/integration/o seu_modelo?since=20181231045803 HTTP/1.1
Host: api.planningpme.com
X-APPKEY: a sua_chave
Authorization: seu_token

O parâmetro "desde" (opcional) permite indicar ao modelo que apenas os elementos criados e modificados após esta data (formato aaaaammddHHHmmss) devem ser exportados.
Na ausência do parâmetro, todos os elementos correspondentes ao modelo solicitado são devolvidos.

Importação com base num modelo específico

Os modelos de importação (marcados com "in") esperam que os dados sejam inseridos ou modificados na base de dados PlanningPME.

POST /a sua_marca/api/integration/o seu_modelo HTTP/1.1
Host: api.planningpme.com
X-APPKEY: a sua_chave
Authorization: seu_token

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

Os parâmetros de execução de uma importação (para além do mapeamento predefinido no modelo) são os seguintes:

  • simular (booleano, por defeito, falso): permite a simulação de uma importação, se verdadeira a resposta será um relatório de todas as inserções e modificações que teriam sido aplicadas na base, permitindo-lhe validar um modelo de importação antes de o executar nos seus dados de produção,
  • verboso (booleano, por defeito, falso): indica se o método deve devolver um relatório das operações processadas,
  • stopOnError (booleano, por defeito falso): se verdadeiro, a importação irá parar assim que um erro for encontrado, se falso, a importação irá continuar com os seguintes elementos,
  • modelo: dados importados como um objecto JSON, estruturados de acordo com o modelo específico definido.

Importação de clientes

POST /a sua_marca/api/integration/client-import HTTP/1.1
Host: api.planningpme.com
X-APPKEY: a sua_chave
Authorization: seu_token

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

Importação de projectos

POST /a sua_marca/api/integration/project-import HTTP/1.1
Host: api.planningpme.com
X-APPKEY: a sua_chave
Authorization: seu_token

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