PlanningPME API

Dieses Dokument enthält folgende Informationen:

Definition und Rolle: Was ist eine API?

Eine API ist eine Schnittstelle zur Programmierung von Anwendungen (Application Programming Interface). Erklären wir jeden dieser Begriffe zum besseren Verständnis:

  • - “Anwendung“: Eine Anwendung ist ein Dienst, auf den ein Mensch oder ein Computerprogramm zugreifen kann.
    Bsp.: Facebook ist eine Anwendung für soziale Netzwerke, Spotify ist eine Audio-Streaming-Anwendung, PlanningPME ist eine Planungsanwendung.
  • - “Programmierung“: Ein Programm ist eine von einem Entwickler geschriebene Reihe von Computerfunktionen, die für ihn Aufgaben ausführt.
    Bsp.: Wenn ich Postadressen in geographische Koordinaten umwandeln möchte, kann ich das von Hand machen oder ich kann ein Programm schreiben, das das für mich erledigt.
  • - “Schnittstelle“: Eine Schnittstelle stellt die Verbindung zwischen zwei Dingen her, in unserem Fall zwischen einer Anwendung und den Programmen, die sie verwenden. Sie definiert, was das Programm von der Anwendung anfordern kann, überträgt die Programmanforderungen an die Anwendung und die Antworten der Anwendung an das Programm.


So wie eine Fernbedienung die Schnittstelle ist, die ein Fernsehzuschauer zur Programmierung seines Fernsehers verwendet, so ist eine API die Schnittstelle, die ein Programmierer zur Interaktion mit einer Anwendung verwendet.

Die PlanningPME-API ist folglich die Schnittstelle der PlanningPME-Anwendung, sie spielt eine wichtige Rolle.
Als obligatorische Grenzübergangsstelle ist sie in der Lage, Zugriffe zu identifizieren, Übertragungen zu sichern, den Umfang der Anfragen zu kontrollieren, usw. …

Volumetrische Daten: Was sind die Aufrufgrenzen der PlanningPME-API?

Jede Installation einer PlanningPME-API ist über einen gesicherten Schlüssel, genannt AppKey, zugänglich, der ein Programm (oder einen Satz von Programmen) gegenüber der API authentifiziert.

Standardmäßig verfügt derselbe AppKey über ein maximales Anfragevolumen von 2.000 pro Stunde.
Bei Überschreitung dieser Grenze wird der Eigentümer des Schlüssels über die Überschreitung informiert und sein Plan gemäß der folgenden Gebührenordnung angepasst.

BasicMilliMicroNanoPlus
2 000 Anfragen pro Stunde3 000 Anfragen pro Stunde5 000 Anfragen pro Stunde8 000 Anfragen pro Stunde+ 10 000 Anfragen pro Stunde
Kostenlos15 € / monat30 € / monat50 € / monatKontaktieren Sie uns

Bsp.: mein Programm erzeugt 4.500 Anfragen in weniger als einer Stunde mit demselben AppKey, ich werde per E-Mail benachrichtigt, dass mein Stundenkontingent den „Micro“-Anteil erreicht hat, und dass mir am Ende des Monats 50 € berechnet werden.

Bei mehr als 10.000 Anfragen pro Stunde ist eine vorherige Vereinbarung obligatorisch.
Jeder Schlüssel, der sich außerhalb dieser maximal erlaubten Nutzungsquote befindet, wird sofort abgeschaltet.

Einsatzzweck: Was sind die Unterschiede zwischen der Standard-API und der Custom-API?

Die PlanningPME-API verfügt über zwei Typen von Operationen.

Die Standard-API gestattet die Ausführung aller regulären Grundoperationen in der PlanningPME-Anwendung.

Bsp.: ein Ereignis hinzufügen / ändern / löschen, einen Kunden / ein Projekt / eine Ressource aktualisieren, die Rechte einer Gruppe ändern, eine Option ändern usw. …

Alle diese Operationen werden in der interaktiven Dokumentation beschrieben.

Die Custom-API gestattet die Ausführung von Massenoperationen in der PlanningPME-Anwendung, und diese Operationen werden innerhalb von Integrationsvorlagen erstellt.

Bsp.: Ich sende die aktualisierten Informationen meiner 25.000 Kunden an die API, in einer einzigen Anfrage und in einem vordefinierten und angepassten Format. Die API ist dafür verantwortlich, bereits bestehende Kunden zu aktualisieren, neue Kunden hinzuzufügen oder sogar veraltete Kunden zu löschen.

Diese Operationen, auch Integrationsoperationen genannt („Integrationsverfahren“ der API), werden innerhalb von Integrationsvorlagen definiert.

Es wird dringend empfohlen, die Custom-API zur Implementierung einer Massensynchronisierung (z. B. Kundentyp / Ressource / Projekt) zu verwenden, um die Verwendungsgrenzen Ihres Schlüssels nicht zu überschreiten. Die Synchronisierung mit der Custom-API kostet nur 1 Anfrage, unabhängig von der Anzahl der in dieser Abfrage aktualisierten Elemente.

Weitere Einzelheiten dazu finden Sie in der Dokumentation der benutzerdefinierten Integrations-API.