HTTP-Workflows

Mit Tesseron haben Sie die Möglichkeit, Workflows nach dem Eingang einer HTTP-Anfrage zu starten.

Alle Informationen zur Anlage neuer Workflows finden Sie unter Workflow erstellen.

Authentifizierung

Die öffentlichen Workflow-Endpunkte erwarten einen gültigen Bearer-Token. Erstellen Sie hierfür einen API-Key mit dem Service „Workflow“.

Der Bearer-Token muss im Request-Header Ihrer Anfrage mitgegeben werden:

Authorization: bearer {apikey}

Endpunkte

Bei der Anlage eines HTTP-Workflows müssen Sie einen Pfad angeben. Mit diesem Pfad ergeben sich für den Workflow die folgenden beiden Endpunkte:

Invoke Endpunkt

Der Invoke Endpunkt wird für synchrone Aufrufe verwendet. In diesem Fall wird der Workflow direkt ausgeführt und das finale Ergebnis sofort zurückgegeben.

{Instanz-URL}/API/Workflow/Invoke/{Pfad} 
Beispiel: https://kunde.tesseron.io/Workflow/Invoke/Monitoring

Ist noch kein finales Ergebnis des Workflows vorhanden, wird der Status-Code 202 Accepted zurückgegeben.

Dispatch Endpunkt

Der Dispatch Endpunkt wird für asynchrone Aufrufe oder länger laufende Workflows ohne sofortiges Ergebnis verwendet. In diesem Fall wird die Workflow-Instnaz eingereiht und sofort der Status-Code 202 Accepted zurückgegeben.

{Instanz-URL}/API/Workflow/Dispatch/{Pfad} 
Beispiel: https://kunde.tesseron.io/Workflow/Dispatch/Monitoring

Zusätzlich erhält der Client Informationen über die InstanceID, die Result URL und Info URL:

{
  "message": "Accepted",
  "success": true,
  "workflowInstanceId": "33f0f32f-b8fe-4bbc-a0f6-b69ea92898bc",
  "resultUrl": "{Instanz-URL}/API/Workflow/Result/33f0f32f-b8fe-4bbc-a0f6-b69ea92898bc",
  "infoUrl": "{Instanz-URL}/API/Workflow/Info/33f0f32f-b8fe-4bbc-a0f6-b69ea92898bc"
}

Result Endpunkt

Über diesen Endpunkt erhalten Sie den aktuellen Antwortzustand der Aktivität.

Beispiel Request:

GET {Instanz-URL}/API/Workflow/Result/33f0f32f-b8fe-4bbc-a0f6-b69ea92898bc
Authorization: Bearer <token>

Beispiel Response:

{
  "workflowInstanceId": "33f0f32f-b8fe-4bbc-a0f6-b69ea92898bc",
  "workflowId": "7f681dc0-7855-4d2f-b5fb-4e0c8b5b8786",
  "status": "Running"
}

Mögliche Antworten:

202 Accepted: Der Workflow ist noch nicht abgeschlossen
200 OK, 201 Created: Der workflow ist final abgeschlossen
409 Conflict: Der Workflow wurde abgebrochen, oder keine Response definiert
401, 403, 404: Fehler

Info Endpunkt

Über diesen Endpunkt erhalten Sie aktuelle Statusinformationen der Workflow Instanz. Die Informationen sind unabhängig von der eigentlichen Workflow-Response.

Beispiel Request:

GET {Instanz-URL}/API/Workflow/Info/33f0f32f-b8fe-4bbc-a0f6-b69ea92898bc
Authorization: Bearer <token>

Beispiel Response:

{
  "workflowId": "7f681dc0-7855-4d2f-b5fb-4e0c8b5b8786",
  "workflowInstanceId": "33f0f32f-b8fe-4bbc-a0f6-b69ea92898bc",
  "status": "Completed"
}

Mögliche Antworten:

200 OK: Workflow wurde erfolgreich abgeschlossen
201 Created: Die Workflow Instanz wurde erfolgreich erstellt
202 Accepted: Workflow wurde angenommen, aber noch nicht abgeschlossen
400 Bad Request: Ungültiger Request oder ungültige Workflow-Konfiguration
401 Unauthorized: Kein gültiger API-Key vorhanden
403 Forbidden: API-Key mit falschem Service angegeben
404 Not Found: Kein passender veröffentlichter Workflow gefunden
500 Internal Server Error: Unerwarteter Fehler

Response

Nutzen Sie in Ihren Workflows die Aktivität HTTP-Antwort.

Mit dieser Aktivität können Sie den gewünschten Status Code sowie den Response Body Ihrer Antworten frei konfigurieren.

Wurde diese Aktivität nicht zu Ihrem HTTP-Workflow hinzugefügt, erhalten Sie lediglich das Ergebnis 202 Accepted.