Versionen im Vergleich
Schlüssel
- Diese Zeile wurde hinzugefügt.
- Diese Zeile wurde entfernt.
- Formatierung wurde geändert.
Status | ||||
---|---|---|---|---|
|
Die Firma teamup bietet einen Kalender in der Cloud an, welcher über eine API verwaltet werden kann. Als Beispiel für die Anbindung des Kalenders per Aktivität HTTP-Request senden wird im Folgenden ein neuer Kalendereintrag erzeugt und bestehende Termine abgerufen.
Endpunkt: https://api.teamup.com
Wie wird authentifiziert? API-Key
Wo finde ich Hilfe? https://apidocs.teamup.com/
Key-Features
Verwenden von URL-Parameter
Verwenden von Header
Verwenden eines API-Keys
Verwenden eines Contents im Json-Format
Voraussetzungen
Es wurde ein Account bei teamup angelegt
Es wurde ein Application-Key beantragt (kann direkt bei der Registrierung des Accounts erfolgen)
Inhalt
Inhalt |
---|
WMS: Konfiguration des HTTP-Endpunkts
Bei der Konfiguration des HTTP-Endpunkts wird lediglich die Basis-URL konfiguriert, welche dann bei der Aktivität mit einer relativen URL ergänzt wird.
Name | Beschreibung |
---|---|
Name | “teamup Calendar” (daraus wird dann die Zuordnungs-Variable “http_teamupCalendar” erstellt, welche in der Aktivität verwendet werden muss) |
URL | “https://api.teamup.com” |
Authentifizierungsart | “Keine” |
Header | Um die API nutzen zu können, wird ein Application-Key benötigt. Sobald ein Account zum teamup Kalender eingerichtet wurde, kann dieser beantragt werden, sobald die Registrierung des Accounts abgeschlossen ist. Wie in der Teamup-Dokumentation beschrieben wird der Application-Key als Header mit dem Namen “Teamup-Token” hinzugefügt. Als Wert wird der Application-Key eingetragen. |
Test der Verbindung
Auf der rechten Seite des Einstellungsfenster kann der Endpunkt getestet werden. Dazu sind zusätzliche Einstellungen notwendig. Dieser werden nicht gespeichert.
Name | Beschreibung |
---|---|
HTTP-Methode | GET |
Relative URL | “check-access” Die API bietet einen eigenen Endpunkt, mit dem die Verbindung getestet werden kann. Hierzu muss die relative URL “check-access” angegeben werden. |
Wird der Test durchgeführt, sollte der StatusCode = 200 sein und im Content-Fenster das Ergebnis im Json-Format angezeigt werden.
Aktivität HTTP-Request: Termine abrufen
Als Beispiel für einen lesenden Zugriff sollen alle Termine des aktuellen Jahres abgerufen werden.
Name | Beschreibung |
---|---|
Endpunkt | Variable für den HTTP-Endpunkt (hier: “http_teamupCalendar”) aus den Zuordnungen. |
Relative URL | strCalendarKeyReader + "/events" Bei Erstellung eines teamup Kalenders werden zwei Zugriffskontrollen für lesenden und schreibenden Zugriff erstellt (im Kalender unter Einstellungen > Zugriffskontrolle). Beide unterscheiden sich durch einen CalendarKey. Dieser muss in der URL angegeben werden. Im Beispiel ist der CalendarKey in der Variablen strCalendarKeyReader hinterlegt. |
HTTP-Methode | GET |
Header | Es sind keine Header erforderlich |
URL Parameter | Im Beispiel sollen alle Termine des aktuellen Jahres ausgelesen werden, wobei die Zeit für die Zeitzone “Berlin” ausgegeben werden soll. Daraus ergeben sich folgende URL Parameter:
|
Image RemovedImage RemovedImage AddedImage Added
Aktivität HTTP-Request: Kalendereintrag erstellen
Um zu zeigen, wie Daten an die API gesendet werden, soll ein Kalendereintrag erstellt werden. In der API ist der Endpunkt schön mit allen notwendigen Informationen (URL, Http-Methode, JSON, mögliche Parameter, ...) beschrieben https://apidocs.teamup.com/docs/api/3269d0159ae9f-create-an-event.
Name | Beschreibung |
---|---|
Endpunkt | Variable für den HTTP-Endpunkt (hier: “http_teamupCalendar”) aus den Zuordnungen. |
Relative URL | strCalendarKeyModifier + "/events" Bei Erstellung eines teamup Kalenders werden zwei Zugriffskontrollen für lesenden und schreibenden Zugriff erstellt (im Kalender unter Einstellungen > Zugriffskontrolle). Beide unterscheiden sich durch einen CalendarKey. Dieser muss in der URL angegeben werden. Im Beispiel ist der CalendarKey für den schreibenden Zugriff in der Variablen strCalendarKeyModifier hinterlegt. |
HTTP-Methode | POST |
Header | Es sind keine Header erforderlich |
Content | Im Content werden die Daten für den Kalendereintrag im Json-Format mit UTF-8 übergeben.
|
Verwandte Themen
Workflow Studio
Nach Stichwort filtern (Inhalt nach Stichwort) | ||||||
---|---|---|---|---|---|---|
|
Weitere Beispiele
Nach Stichwort filtern (Inhalt nach Stichwort) | ||||||
---|---|---|---|---|---|---|
|