PlanningPME

PlanningPME API - Benutzerdefinierte Integration

PlanningPME bietet eine benutzerdefinierte Integrations-API für die Synchronisierung von PlanningPME-Daten mit Tier-Anwendungen.

Dieses Dokument beantwortet die folgenden Fragen:

Wozu eine „benutzerdefinierte“ Integrations-API?
Wie funktioniert eine benutzerdefinierte Integrations-API?
Welche Art von Integration kann sofort durchgeführt werden?
Wie können wir bei einer ganz spezifischen Integration helfen?
Wie erstelle ich eine Integrationsanforderung?

Wozu eine „benutzerdefinierte“ Integrations-API?

Die Synchronisierung von Daten zwischen Diensten ist heutzutage eine häufige Angelegenheit. Verschiedene Dienste benötigen möglicherweise die gleichen Daten, aber niemand möchte diese Daten zweimal verwalten.
PlanningPME stellt die Werkzeuge für den Datenaustausch mit dem restlichen Informationssystem zur Verfügung.

In der Praxis ist es nicht immer möglich, einen Datenexport an die Einschränkungen des Systems, das sie verwenden wird, anzupassen. Und vielleicht möchten Sie Ihre Daten nicht an ein neues Modell anpassen, um sie mit einer anderen Anwendung zu teilen.
PlanningPME bietet Ihnen diese Flexibilität bei der Datenerfassung und -präsentation mit der benutzerdefinierten Integrations-API.

Diese Flexibilität gilt sowohl für Ihre proprietären Anwendungen als auch für die am weitesten verbreiteten Anwendungen, wie z. B. CRM (SalesForce, Microsoft Dynamics ...) oder ERP (SAP, Oracle ...).
PlanningPME arbeitet an der kontinuierlichen Implementierung von Austauschmodellen, die auf die am meisten verwendeten Anwendungen auf dem Markt zugeschnitten sind.

Zusammenfassend hat die benutzerdefinierte Integrations-API zwei wesentliche Vorteile gegenüber der traditionellen API:
  • Sie arbeitet mit Vorlagen, die vollständig an Ihr eigenes Datenmodell angepasst sind,
  • Sie ermöglicht die Massensynchronisation in einer einzigen Abfrage, wodurch Kontingentbeschränkungen vermieden werden.

Wie funktioniert eine benutzerdefinierte Integrations-API?

Die Definition des Modells ermöglicht die gesamte Flexibilität, die für die Datenerfassung und -präsentation erforderlich ist.
Es gibt zwei Arten von Vorlagen: Importvorlagen zum Importieren von Daten in PlanningPME und Exportvorlagen zum Exportieren von PlanningPME-Daten.
Eine Importvorlage definiert den Abgleich zwischen den empfangenen Feldern und den Feldern von PlanningPME, während eine Exportvorlage die Übereinstimmung zwischen den exportierten Feldern von PlanningPME und denen der Zielanwendung definiert.
Eine Vorlage definiert auch die Formatierung oder Kopplung von Daten sowie die Standardwerte und die Verarbeitung.

Muster-Importvorlage

<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 dieser Vorlage definieren wir einen Kundenimport, der Daten einfügen oder aktualisieren kann.
Ein Standardwert wird für die Art des Kunden definiert (alle Kunden sind Einzelpersonen).
Schließlich definieren wir die Entsprechung zwischen den erhaltenen Feldern und den PlanningPME-Feldern (ob es benutzerdefinierte Felder oder generische Felder sind).

Sobald es auf Ihrer API implementiert ist, können Sie mit diesem Modell Daten importieren, ohne sich über das PlanningPME-Schema Gedanken machen zu müssen.

Einsatzbereite Integrationsvorlagen

Diese einsatzbereiten Vorlagen sind standardmäßig in jeder API-Installation verfügbar:

Diese Liste wird voraussichtlich mit der Anzahl der Anfragen für bekannte Anwendungen von Drittanbietern oder für allgemeine Bedürfnisse wachsen.

Implementierung spezifischer Fälle

Richten Sie Ihre spezifische Anfrage an unseren Support, damit dieser sie studiert und eine neue, vollständig an Ihren Fall angepasste Vorlage erstellt (die Entwicklungskosten können je nach Komplexität der Integration festgelegt werden).

Maßgeschneiderte Vorlagen werden häufig für Kunden implementiert, die eine Massensynchronisierung durchführen möchten, ohne das Risiko einzugehen, die Nutzungskontingente ihrer APIs zu überschreiten.

Meistens wollen Kunden auch einfach ihr eigenes Datenmodell verwenden, um mit PlanningPME zu interagieren. Dies ermöglicht die benutzerdefinierte Integrations-API, unabhängig vom Komplexitätsgrad des ursprünglichen Modells.
Es kommt z. B. vor, dass dieselbe Entität des ursprünglichen Modells verschiedenen Entitäten im PlanningPME-Modell entspricht. Die benutzerdefinierte Integration ermöglicht es, dieselbe Linie auf mehrere Entitäten aufzuteilen, was diese Art von Synchronisationen erheblich erleichtert.

Welche Integration auch immer zu erwarten ist, unsere Antwort wird auf Ihre Bedürfnisse und Ihr Umfeld zugeschnitten sein.
Gerne arbeiten wir gemeinsam mit Ihnen an der Entwicklung.

Zögern Sie nicht, mit uns in Kontakt zu treten, um weitere Informationen zu erhalten oder Ihre Integration zu spezifizieren.

Beispiele für Anfragen zur benutzerdefinierten Integration der API

Die benutzerdefinierte Integrations-API ist Teil der PlanningPME-API. Die Grundlagen der Interaktion mit der API entnehmen Sie bitte der Entwicklerdokumentation.

Integrationsvorlagen

Die auf Ihrer API installierten benutzerdefinierten Integrationsvorlagen können mit dem folgenden Aufruf abgerufen werden.

GET /your_brand/api/integration/templates HTTP/1.1
Host: api.planningpme.com
X-APPKEY: Ihr_Schlüssel
Authorization: Ihr_Token

Diese Methode gibt die installierten Datenimport- und -exportvorlagen und ihre detaillierte Beschreibung zurück.

Export auf der Basis einer spezifischen Vorlage

Exportvorlagen geben die in der PlanningPME-Datenbank gefundenen Daten zurück.

GET /votre_marque/api/integration/ihre_vorlage?since=20181231045803 HTTP/1.1
Host: api.planningpme.com
X-APPKEY: Ihr_Schlüssel
Authorization: Ihr_Token

Der Parameter "since" (optional) erlaubt es, der Vorlage anzugeben, dass nur die Elemente, die nach diesem Datum (Format JJJJMMTTHHmmss) erstellt und geändert wurden, exportiert werden müssen.
Wenn der Parameter nicht vorhanden ist, werden alle Elemente, die dem angeforderten Modell entsprechen, zurückgegeben.

Import auf der Basis einer spezifischen Vorlage

Importvorlagen (mit "in" markiert) erwarten, dass Daten in die PlanningPME-Datenbank eingefügt oder darin geändert werden.

POST /your_brand/api/integration/ihre_vorlage HTTP/1.1
Host: api.planningpme.com
X-APPKEY: Ihr_Schlüssel
Authorization: Ihr_Token

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

Ausführungsparameter eines Imports (zusätzlich zu der im Modell vordefinierten Abbildung) sind die folgenden:

  • simulate (boolesch, Standardeinstellung auf false): ermöglicht die Simulation eines Imports, wenn true, wird die Antwort ein Bericht über alle Einfügungen und Änderungen sein, die sonst in der Datenbank angewendet worden wären, so dass Sie ein Importmodell validieren können, bevor Sie es mit Ihren Produktionsdaten ausführen,
  • verbose (boolesch, standardmäßig auf false): gibt an, ob die Methode einen Bericht über die verarbeiteten Operationen zurückgeben soll,
  • stopOnError (boolesch, voreingestellt auf false): wenn true wird der Import gestoppt, sobald ein Fehler auftritt, wenn false wird der Import mit den folgenden Elementen fortgesetzt,
  • model: importierte Daten als JSON-Objekt, strukturiert gemäß dem definierten spezifischen Modell.

Kundenimport

POST /your_brand/api/integration/client-import HTTP/1.1
Host: api.planningpme.com
X-APPKEY: Ihr_Schlüssel
Authorization: Ihr_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: Ihr_Schlüssel
Authorization: Ihr_Token

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