Definition der API-REST
SREST (REpresentational State Transfer) – ein auf dem HTTP-Protokoll basierender Webdienst, definiert durch:
- eine Basis-URL (z. B.: http:///api/v2/events)
- eine Standard-HTTP-Methode (GET, POST, PUT und DELETE)
- ein Medientyp oder „Datenformat“ (XML, JSON…)
Datenformat
Das von der REST V2-API verwendete Format ist JSON (strukturierte Daten auf Basis von Listen [Wert_1, …, Wert_n] und Wörterbüchern {Schlüssel_1:Wert_1, …, Schlüssel_n:Wert_n}).
API-Schlüssel
API-Schlüssel für Administratoren
Diese werden im Abschnitt WebService des Bearbeitungsfensters „Allgemeine Einstellungen“ im Admin Center definiert.
Sie ermöglicht den Zugriff auf die Verwaltungsfunktionen (Lesen, Anlegen, Ändern und Löschen) von Gruppen und Anwendern im Admin Center.
API-Planungsschlüssel
Diese sind im Abschnitt WebService des Planungsbearbeitungsfensters im Admin Center definiert.
Sie erteilt einem Anwender die Berechtigung, auf Daten in einem Planer zuzugreifen, und ermöglicht die Identifizierung des Anwenders, um die Berechtigungen anzuwenden, die der Gruppe gewährt wurden, zu der der Anwender gehört.
Die Funktionen zum Lesen, Erstellen, Ändern und Löschen gelten für Ressourcen, Vorgänge und Verknüpfungen zwischen Vorgängen.
Keine der Funktionen der REST V2-API ermöglicht es Ihnen, auch nur den geringsten Vorgang an einem
Parameter der Planung.
Das Konzept der API-Sitzung
Eine API-Sitzung wird auf dem Server registriert, sobald die erste Anfrage gestellt wird, und endet automatisch, wenn 15 Minuten lang keine Operation durchgeführt wurde.
Solange eine API-Sitzung aktiv ist, werden Änderungen an den Einstellungen für Planungen nicht berücksichtigt.
Um etwaige Änderungen an den Einstellungen bei nachfolgenden API-Anfragen zu berücksichtigen, muss diese Sitzung zunächst über den API-Zugangspunkt gelöscht werden.
Wenn Sie das nächste Mal eine Anfrage stellen, wird eine neue Sitzung erstellt, wobei die von Ihnen vorgenommenen Änderungen an Ihren Einstellungen berücksichtigt werden.
ONLINE-DOKUMENTATION
| Sprache | Links |
|---|---|
| FR | https://app.swaggerhub.com/apis-docs/VisualPlanning/Visual- Planning_API_REST_v2.0/2.0-oas3 |
| EN/US | https://app.swaggerhub.com/apis-docs/VisualPlanning/visual- planning_api_rest_v_2_0_us/2.0-oas3 |