Über die API von iPM_Promotion kann lesend auf verschiedene Datenbereiche des Systems zugegriffen werden. So können Daten für Projekte, Jobs, Termine, Einsätze, Aktionsstandorte und natürlich auch für die Feedbacks abgefragt werden. Verschiedene Endpunkte innerhalb der API dienen dazu, systeminterne Sichtbarkeitseinschränkungen zu berücksichtigen und einen einfachen Zugriff auf bestimmte Daten zu erhalten. So können z. B. die Einsätze eines bestimmten Projekts abgefragt werden oder die für einen Kunden sichtbaren Termine unter Berücksichtigung aller für ihn geltenden Sichtbarkeitseinschränkungen.
Die Endpunkte der API liegen auf den kunden- und systemindividuellen URLs unter https://meine-domain.de/api/1/, wobei /1 für die Version steht. Zum Beispiel liegt der Termin-Endpunkt für die Domain promosoftware.de auf https://promosoftware.de/api/1/termine.
Die Rückgabe der API erfolgt in JSON oder XML, die Authentifizierung erfolgt über einen API-Key im HTTP-Header oder als GET-Parameter. Die Datenstrukturen der einzelnen Datenbereiche können über einen GET-Parameter angepasst und erweitert werden. So können z. B. auch bei der Abfrage der Termine alle Daten des Projekts, zu dem der Termin gehört, mit ausgegeben werden.
Achtung: Den individuellen API-Key erhalten Sie als Nutzer der Premium-Version von iPM_Promotion auf Anfrage. Gerne lassen wir Ihnen kurzfristig Ihren Key zukommen.
Eine ausführliche Dokumentation der API sowie der verfügbaren Endpunkte und Datenstrukturen ist unter http://api.ipm-promotion.de/ verfügbar.
Über diese API können komplexe Auswertungen also direkt mit den Daten des iPM_Promotion-Systems durchgeführt werden. Ebenso können mit dieser Schnittstelle auch in externen Tools, wie z. B. Business-Intelligence-Lösungen, komplexe Auswertungen sowie Charts erstellt werden. Aber auch andere Anwendungsfälle lassen sich hierüber abbilden, z. B. Ziellerreichung, KPI-Kontrollen, geografische Verteilung der Abverkäufe etc.
