Die API in enaio® coLab

enaio® coLab 11.10

Diese Funktionalität muss aktiviert werden, und zwar durch einen Eintrag api-enabled: true in der colab-prod.yml-Datei. Wenn der Schlüssel nicht vorhanden ist oder der Schlüsselwert false ist, ist die API deaktiviert.

Für enaio® coLab steht eine Rest-API zur Verfügung, die Endpunkte bereitstellt, die es ermöglichen, den Lebenszyklus eines Projektraums von externen Anwendungen aus zu steuern.

Beispielhafter Anwendungsfall

Beim Anlegen eines neuen Geschäftsvorfalls ist es beispielsweise möglich, über ein Skript automatisch einen Projektraum für diesen Geschäftsvorgang anzulegen. Die am Geschäftsvorfall beteiligten Personen können über die API mit ihrer E-Mail-Adresse eingeladen werden. Über die API kann dann geprüft werden, ob die Einladungen angenommen wurden. Nach Abschluss des Geschäftsvorfalls kann der Projektraum per Skript wieder gelöscht werden, z. B. gesteuert durch einen Status im Indexdatenfeld.

Autorisierung

Die Nutzung der API erfordert eine Autorisierung per Token. Token können vom coLab-Administrator erstellt und gelöscht werden. Das Erstellen bzw. das Löschen der Token erfolgt im enaio® coLab-Client, im Bereich Admin-Einstellungen > API.

Der Token ist Teil der API-Anfrage. Die Anfrage an die API muss das Token und alle notwendigen Daten enthalten, die für den aufgerufenen Endpunkt relevant sind (Root-Objekt-ID, Benutzer-ID, Einladungs-E-Mail ...). Die Gültigkeit des Tokens kann zeitlich begrenzt sein.

Die API-Aufrufe werden protokolliert (einschließlich verschiedener Log-Level), um eine einfache Fehleranalyse zu ermöglichen. API-Aufrufe geben detaillierte Fehlerinformationen zurück, soweit eine Fehlerdokumentation existiert.

Die detaillierte API-Dokumentation finden Sie unter API für Projektraummanagement.