API-Konfiguration
APIs in Dastra konfigurieren
API steht für Application Programming Interface (Programmierschnittstelle).
APIs ermöglichen es, die Dastra-Plattform mit anderen externen Tools zu verbinden.
Die Möglichkeiten sind vielfältig: Verbindung mit einer CRM-Software zur automatisierten Übernahme von Beteiligten, Synchronisation eines Tools zur Verwaltung von Betroffenenrechten mit dem Dastra-Modul usw.
Dastra basiert auf dem Standard API-Rest und insbesondere auf den folgenden HTTP-Anfragen:
Sammlungsressource, wie http://api.beispiel.com/collection/
Ruft die URIs der Mitgliedsressourcen der Sammlungsressource im Antwortkörper ab.
Erstellt eine Mitgliedsressource in der Sammlungsressource unter Verwendung der Anweisungen des Anfragekörpers. Die URI der erstellten Mitgliedsressource wird automatisch zugewiesen und im Location-Header-Feld der Antwort zurückgegeben.
Ersetzt alle Darstellungen der Mitgliedsressourcen der Sammlungsressource durch die Darstellung im Anfragekörper oder erstellt die Sammlungsressource, wenn sie nicht existiert.
Aktualisiert alle Darstellungen der Mitgliedsressourcen der Sammlungsressource unter Verwendung der Anweisungen des Anfragekörpers oder erstellt gegebenenfalls die Sammlungsressource, wenn sie nicht existiert.
Löscht alle Darstellungen der Mitgliedsressourcen der Sammlungsressource.
Mitgliedsressource, wie http://api.beispiel.com/collection/item3
Ruft eine Darstellung der Mitgliedsressource im Antwortkörper ab.
Erstellt eine Mitgliedsressource in der Mitgliedsressource unter Verwendung der Anweisungen des Anfragekörpers. Die URI der erstellten Mitgliedsressource wird automatisch zugewiesen und im Location-Header-Feld der Antwort zurückgegeben.
Ersetzt alle Darstellungen der Mitgliedsressource oder erstellt die Mitgliedsressource, wenn sie nicht existiert, durch die Darstellung im Anfragekörper.
Aktualisiert alle Darstellungen der Mitgliedsressource oder erstellt gegebenenfalls die Mitgliedsressource, wenn sie nicht existiert, unter Verwendung der Anweisungen des Anfragekörpers.
Löscht alle Darstellungen der Mitgliedsressource.
Quelle: Wikipedia
Mit Dastra ist es möglich, mehrere APIs zu konfigurieren. Die Liste der APIs ist hier verfügbar: https://api.dastra.eu/swagger/index.html
Einschränkungen
Ein HTTP-Anfragelimit ist auf 500/Min. oder 10.000/10 Min. festgelegt.
Die Sicherheitsoptionen (insbesondere IP-Filterung) gelten nicht für APIs.
Bereitstellung benutzerdefinierter Felder in der Dastra-API
In Dastra ist es möglich, benutzerdefinierte Felder, die in Ihrem Dastra-Mandanten erstellt wurden, über die API bereitzustellen.
Benutzerdefinierte Felder sind für jeden Mandanten spezifisch. Um sie in der Dastra-API zu berücksichtigen, muss zunächst der Variablenname in der Definition des benutzerdefinierten Feldes festgelegt werden:
Die meisten über die API bearbeitbaren Entitäten stellen ein Feld namens "customFields" bereit, das Sie ändern können.
Wenn Sie die Felder mit den folgenden Variablennamen in Ihrem Mandanten definieren:
mein_string_feld: ein "Text"-Feld
mein_boolean_feld: ein "Kontrollkästchen"-Feld
mein_numerisches_feld: ein "Zahl"-Feld
mein_checkbox_feld: ein "Kontrollkästchen"-Feld (Mehrfachauswahl)
Dann können diese Informationen wie folgt geändert werden
Der Fall der Tags
Um Tags in der Dastra-API bereitzustellen, müssen Sie diese zunächst über den Tags-Endpunkt abrufen: /v1/ws/{workspaceId}/Tags
HINWEIS: Verwenden Sie APIs nur, wenn Sie wissen, was Sie tun!
Die API-Verwaltungsoberfläche in Dastra finden Sie unter dieser Adresse: https://app.dastra.eu/general-settings/api
Zuletzt aktualisiert
War das hilfreich?