PlanningPME API - Integrazione cliente

PlanningPME dispone di un’integrazione cliente API, per sincronizzare i dati di PlanningPME con applicazioni terze.

Questo documento risponde alle seguenti domande:

Perché una API di integrazione “personalizzata”?
Come funziona la API per l’integrazione personalizzata?
Che tipo di integrazione può essere realizzata fuori dagli schemi?
Come possiamo aiutare con un'integrazione molto specifica?
Come effettuare una richiesta di integrazione?

Perché una API di integrazione “personalizzata”?

La sincronizzazione dei dati tra i servizi è una prassi comune attualmente. Servizi diversi possono richiedere lo stesso dato, ma nessuno vuole gestire questi dati due volte.
PlanningPME fornisce gli strumenti per consentire lo scambio di dati con il resto del sistema informativo.

Di fatto, non sempre è possibile adattare un'esportazione di dati ai vincoli del sistema che li utilizzerà. E potreste non voler adattare i vostri dati a un nuovo modello da condividere con un'altra applicazione.
PlanningPME vi offre questa flessibilità per l'acquisizione e la presentazione dei dati con la API di integrazione personalizzata.

Questa flessibilità vale sia per le applicazioni proprietarie che per le applicazioni più diffuse, come CRM (SalesForce, Microsoft Dynamics ...) o ERP (SAP, Oracle ...).
PlanningPME lavora alla continua implementazione di modelli di scambio specifici per le applicazioni più utilizzate sul mercato.

In breve, la API di integrazione personalizzata presenta due vantaggi fondamentali rispetto alla API tradizionale:
  • funziona con modelli completamente adattati al proprio modello di dati,
  • consente la sincronizzazione di massa in un'unica richiesta, evitando così restrizioni di quote.

Come funziona la API per l’integrazione personalizzata?

Grazie alla definizione del modello è possibile ottenere tutta la flessibilità necessaria per l'acquisizione e la presentazione dei dati.
Ci sono due tipi di template: i template di importazione per l'importazione di dati in PlanningPME e i template di esportazione per l'esportazione di dati PlanningPME.
Un template di importazione definisce la corrispondenza tra i campi ricevuti e i campi di PlanningPME, mentre un template di esportazione definisce la corrispondenza tra i campi esportati di PlanningPME e quelli dell'applicazione di destinazione.
Un template definisce anche la formattazione o l'accoppiamento dei dati, così come i valori di default e l'elaborazione.

Esempi di template di importazione

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

In questo template definiamo un'importazione cliente che può inserire o aggiornare i dati.
Si definisce un valore predefinito per il tipo di cliente (tutti i clienti sono persone fisiche).
Infine, definiamo la corrispondenza tra i campi ricevuti e i campi di PlanningPME (sia che si tratti di campi personalizzati o generici).

Appena implementato sulla vostra API, questo modello vi permette di importare i dati senza preoccuparvi dello schema PlanningPME.

Template inegrazione pronti all’uso

Questi template pronti all'uso sono disponibili di default in ogni installazione API:

Questo elenco è destinato a crescere con l'aumentare delle richieste di applicazioni note di terze parti o per esigenze generiche.

Implementazione di un caso specifico

Sottoponete la vostra richiesta specifica al nostro servizio di assistenza affinché la studi e generi un nuovo modello interamente adattato al vostro caso (i costi di sviluppo possono essere stabiliti in base alla complessità dell'integrazione).

I template personalizzati sono spesso implementati per i clienti che desiderano effettuare la sincronizzazione di massa senza il rischio di raggiungere le limitazioni di quota di utilizzo delle loro API.

La maggior parte delle volte i clienti desiderano anche semplicemente utilizzare il proprio modello di dati per interagire con PlanningPME. Questo è ciò che la API di integrazione personalizzata consente, indipendentemente dal livello di complessità del modello originale.
Accade, per esempio, che la stessa entità del modello originale corrisponda ad entità diverse nel modello PlanningPME. L'integrazione personalizzata permette di dividere la stessa linea su più entità, il che facilita notevolmente questo tipo di sincronizzazioni.

Qualunque sia l'integrazione da aspettarsi, la nostra risposta sarà personalizzata in base alle vostre esigenze e all'ambiente.
Saremo lieti di lavorare con voi al suo sviluppo.

Non esitate a contattarci per maggiori informazioni o specificare la vostra integrazione.

Esempi di richieste di integrazione personalizzata delle API

L’integrazione personalizzata della API fa parte della API PlanningPME, consultare documentazione per gli sviluppatori per l’interazione di base con la API.

Template di integrazione

I template di integrazione personalizzati installati sulle vostre API possono essere richiamati con la seguente chiamata.

GET /your_brand/api/integration/templates HTTP/1.1
Host: api.planningpme.com
X-APPKEY: your_key
Authorization: your_token

Questo metodo restituisce i modelli di importazione ed esportazione dei dati installati e la loro descrizione dettagliata.

Esportazione basata su un template specifico

I template di esportazione restituiscono i dati trovati nel database di PlanningPME.

GET /votre_marque/api/integration/tuo_template?since=20181231045803 HTTP/1.1
Host: api.planningpme.com
X-APPKEY: your_key
Authorization: your_token

Il parametro "since" (opzionale) permette di indicare al template che solo gli elementi creati e modificati dopo questa data (formato aaaammggHmmss) devono essere esportati.
In assenza del parametro vengono restituiti tutti gli elementi corrispondenti al modello richiesto.

Importazione basata su un modello specifico

I template di importazione (contrassegnati con "in") prevedono l'inserimento o la modifica dei dati nel database di PlanningPME.

POST /your_brand/api/integration/tuo_template HTTP/1.1
Host: api.planningpme.com
X-APPKEY: your_key
Authorization: your_token

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

I parametri di esecuzione di un'importazione (oltre alla mappatura predefinita nel modello) sono i seguenti:

  • simulate (booleano, default su falso): permette la simulazione di un'importazione, se è vera la risposta sarà un report di tutti gli inserimenti e le modifiche che altrimenti sarebbero stati applicati di base, permettendo di convalidare un modello di importazione prima di eseguirlo sui dati di produzione,
  • verbose (booleano, default su falso): indica se il metodo deve restituire un rapporto delle operazioni elaborate,
  • stopOnError (booleano, default su falso): se è vero l'importazione si interrompe non appena si incontra un errore, se è falso l'importazione continua con i seguenti elementi,
  • modello: dati importati come oggetto JSON, strutturati secondo lo specifico modello definito.

Importazione cliente

POST /your_brand/api/integration/client-import HTTP/1.1
Host: api.planningpme.com
X-APPKEY: your_key
Authorization: your_token

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

Importazione progetto

POST /your_brand/api/integration/project-import HTTP/1.1
Host: api.planningpme.com
X-APPKEY: your_key
Authorization: your_token

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