PlanningPME tillhandahåller ett anpassat API för integration för att synkronisera PlanningPME-data med nivå-applikationer.

I detta dokument besvarar följande frågor:

Varför ett "anpassat" integrations-API?
Hur fungerar anpassat integrations-API?
Vilken typ av integration kan göras omedelbart utan konfigurering?
Hur kan vi hjälpa dig med mycket specifik integration?
Hur gör man en integrationsbegäran?

Provimportmall

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

I den här mallen definierar vi en kundimport som kan infoga eller uppdatera data.
Ett standardvärde definieras för kundtypen (alla kunder är individer).
Slutligen definierar vi korrespondensen mellan de mottagna fälten och PlanningPME-fälten (vare sig anpassade fält eller generiska fält) .

Så snart det har implementerats på ditt API kan du med den här modellen importera data utan att oroa dig för PlanningPME-schemat.

Dessa färdiga mallar är som standard tillgängliga i varje API-installation:

• Kundimport (sedan version 4.1.1.116)
• Projektimport (sedan version 4.1.1.116)

Denna lista förväntas växa i takt med förfrågningar om kända tredjepartsapplikationer eller generiska behov.

Vänd dig till vår support med din specifika förfrågan så att de kan titta på den och generera en ny mall som är helt anpassad till ditt fall (utvecklingskostnader kan fastställas beroende på komplexiteten i integrationen).

Anpassade mallar implementeras ofta för kunder som vill göra massynkronisering utan risken att uppnå användningskvotbegränsningarna för sina API:er.

För det mesta vill kunderna helt enkelt använda sin egen datamodell för att interagera med PlanningPME. Det är vad det anpassade integrations-API:t tillåter, oavsett graden av komplexitet hos den ursprungliga modellen.
Det händer till exempel att samma enhet i den ursprungliga modellen motsvarar olika enheter i PlanningPME-modellen. Den anpassade integrationen gör det möjligt att dela samma linje på flera enheter, vilket i hög grad underlättar denna typ av synkroniseringar.

Oavsett vilken integration man kan förvänta sig kommer vår lösning att anpassas till dina behov och din miljö.
Vi arbetar gärna med att utveckla den tillsammans med dig.

Tveka inte att kontakta oss för mer information eller för att specificera din integration.

Det anpassade integrations-API:t är en del av PlanningPME API, se utvecklardokumentation för grunderna i interaktion med API:t.

Integrationsmallar

De anpassade integrationsmallarna som installerats på ditt API kan hämtas med följande anrop.

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

Denna metod returnerar de installerade mallarna för import och export av data och deras detaljerade beskrivning.

Export baserat på en specifik mall

Exportmallar returnerar data som finns i PlanningPME-databasen.

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

Parametern "sedan" (valfritt) gör det möjligt att indikera för mallen att endast de element som skapats och modifierats efter detta datum (format ååååMMddTTmmss) måste exporteras.
Vid avsaknad av parametern returneras alla element som motsvarar den begärda modellen.

Import baserat på en specifik modell

Importmallar (markerade "in") förväntar sig att data ska läggas in eller ändras i PlanningPME-databasen.

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

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

Exekveringsparametrarna för en import (utöver den fördefinierade kartläggningen i modellen) är följande:

• simulera (boolisk, som standard är ”false”): möjliggör simulering av en import, om ”true” är svaret en rapport om alla infogningar och modifieringar som annars skulle ha använts i basen, så att du kan validera en importmodell innan du kör den på dina produktionsdata,
• verbose (boolisk, som standard är ”false”): anger om metoden ska returnera en rapport om bearbetade operationer,
• stopOnError (boolisk, som standard är ”false”): om det är ”true” kommer importen att stoppas så snart ett fel har uppstått, om ”false” kommer importen att fortsätta med följande element,
• modell: importerade data som ett JSON-objekt, strukturerat enligt den specifika modell som definierats.

Kundimport

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: {
		...
	}
}

Projektimport

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: {
		...
	}
}