PlanningPME API - Aangepaste integratie

PlanningPME biedt een aangepaste integratie-API voor het synchroniseren van PlanningPME-gegevens met tier-applicaties.

Dit document beantwoordt de volgende vragen:

Waarom een "aangepaste" integratie-API?

Het synchroniseren van gegevens tussen services is tegenwoordig een veel voorkomende zaak. Verschillende services kunnen dezelfde gegevens vereisen, maar niemand wil deze gegevens twee keer beheren.
PlanningPME biedt de tools om gegevens uit te wisselen met de rest van uw informatiesysteem.

in de praktijk is het niet altijd mogelijk om een gegevensexport aan te passen aan de beperkingen van het systeem dat ze zal gebruiken. En misschien wilt u uw gegevens niet aanpassen aan een nieuw model om te delen met een andere applicatie.
PlanningPME biedt u deze flexibiliteit voor gegevensverzameling en -presentatie met de aangepaste integratie-API.

Deze flexibiliteit is van toepassing op uw eigen applicaties en op de meest voorkomende applicaties, zoals CRM (SalesForce, Microsoft Dynamics ...) of ERP (SAP, Oracle ...).
PlanningPME werkt aan de continue implementatie van uitwisselingsmodellen die specifiek zijn voor de meest gebruikte applicaties op de markt.

Samenvattend heeft de aangepaste integratie-API twee grote voordelen ten opzichte van de traditionele API :
  • het werkt met sjablonen die volledig zijn aangepast aan uw eigen datamodel,
  • het staat massasynchronisatie in een enkele query toe, waardoor quotabeperkingen worden vermeden.

Hoe aangepaste integratie-API werkt?

Modeldefinitie biedt alle flexibiliteit die nodig is voor data-acquisitie en presentatie.
Er zijn twee soorten sjablonen: importsjablonen voor het importeren van gegevens naar PlanningPME en exportsjablonen voor het exporteren van PlanningPME-gegevens.
Een importsjabloon definieert de overeenstemming tussen de ontvangen velden en de PlanningPME-velden, terwijl een exportsjabloon de correspondentie definieert tussen de geŰxporteerde velden van PlanningPME en die van de doeltoepassing.
Een sjabloon definieert ook de opmaak of koppeling van gegevens, evenals standaardwaarden en verwerking.

Voorbeeld importsjabloon

<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 deze sjabloon definiŰren we een klantimport die gegevens kan invoegen of bijwerken.
Een standaardwaarde is gedefinieerd voor het type klant (alle klanten zijn individuen).
Ten slotte definiŰren we de correspondentie tussen de ontvangen velden en de PlanningPME-velden (of het nu aangepaste velden of generieke velden) .

Zodra het op uw API is ge´mplementeerd, kunt u met dit model gegevens importeren zonder u zorgen te maken over het PlanningPME-schema.

Gebruiksklare integratiesjablonen

Die gebruiksklare sjablonen zijn standaard beschikbaar in elke API-installatie:

Deze lijst zal naar verwachting groeien als en wanneer aanvragen voor bekende toepassingen van derden, of voor generieke behoeften.

Specifieke case-implementatie

Stel uw specifieke aanvraag bloot aan onze ondersteuning zodat deze deze bestudeert en een nieuw sjabloon genereert dat volledig is aangepast aan uw case (ontwikkelingskosten kunnen worden vastgesteld op basis van de complexiteit van de integratie).

Aangepaste sjablonen worden vaak ge´mplementeerd voor klanten die massasynchronisatie willen uitvoeren zonder het risico te lopen de beperkingen van de gebruiksquota van hun API's te bereiken.

Meestal willen klanten ook gewoon hun eigen datamodel gebruiken om te communiceren met PlanningPME. Dit is wat de aangepaste integratie-API mogelijk maakt, ongeacht de complexiteit van het oorspronkelijke model.
Het komt bijvoorbeeld voor dat dezelfde entiteit van het oorspronkelijke model overeenkomt met verschillende entiteiten in het PlanningPME-model. De aangepaste integratie maakt het mogelijk om dezelfde lijn over meerdere entiteiten te splitsen, wat dit soort synchronisaties aanzienlijk vergemakkelijkt.

Wat de integratie ook is, onze reactie is aangepast aan uw behoeften en uw omgeving.
We werken graag met u samen aan de ontwikkeling ervan.

Aarzel niet om contact met ons op te nemen voor meer informatie of om uw integratie aan te geven.

Voorbeelden van aangepaste API-integratieverzoeken

De aangepaste integratie-API is onderdeel van de PlanningPME API. Raadpleeg de documentatie voor ontwikkelaars voor de basisprincipes van interactie met de API.

Integratiesjablonen

De aangepaste integratiesjablonen die op uw API zijn ge´nstalleerd, kunnen worden opgehaald met behulp van de volgende aanroep.

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

Deze methode retourneert de ge´nstalleerde sjablonen voor het importeren en exporteren van gegevens en hun gedetailleerde beschrijving.

Exporteren op basis van een specifieke sjabloon

Exportsjablonen retourneren de gegevens in de PlanningPME-database.

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

De parameter "since" (optioneel) maakt het mogelijk aan de sjabloon aan te geven dat alleen de elementen die na deze datum zijn gemaakt en gewijzigd (indeling jjjjMMddHHmmss) moeten worden geŰxporteerd.
Bij afwezigheid van de parameter worden alle elementen geretourneerd die overeenkomen met het gevraagde model.

Importeren op basis van een specifiek model

Importsjablonen (gemarkeerd met "in") verwachten dat gegevens worden ingevoegd of gewijzigd in de PlanningPME-database.

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

De uitvoeringsparameters van een import (naast de vooraf gedefinieerde toewijzing in het model) zijn de volgende:

  • simulate (boolean, standaard onwaar): staat simulatie van een import toe, indien waar is het antwoord een rapport van alle invoegingen en wijzigingen die anders in base zouden zijn toegepast, zodat u een importmodel kunt valideren voordat u het uitvoert op uw productie data,
  • verbose (boolean, standaard onwaar): geeft aan of de methode een rapport van verwerkte bewerkingen moet retourneren,
  • stopOnError (boolean, standaard onwaar): indien waar stopt de import zodra er een fout wordt aangetroffen, indien onwaar gaat de import verder met de volgende elementen,
  • model: ge´mporteerde gegevens als een JSON-object, gestructureerd volgens het specifieke gedefinieerde model.

Klantimport

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

Project importeren

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