Zum Hauptinhalt springen

REST-API

LoyJoy bietet eine REST-API für den programmatischen Zugriff auf Prozesse, Home Views, Kataloge, Artikel, Benachrichtigungen und Variablen.

Autorisierung​

Alle folgenden Endpunkte erfordern eine Autorisierung mit einem Bearer-Zugriffstoken. Ein solches Zugriffstoken kann unter cloud.loyjoy.com in den Tenant-Einstellungen im Tab API abgerufen werden. Bitte beachten Sie, dass das Zugriffstoken mit dem Benutzerkonto und dem Tenant verknüpft ist, für die es erzeugt wurde. Wenn ein Benutzer aus einem Tenant entfernt wird, wird das Zugriffstoken daher ungültig.

Darüber hinaus muss das Zugriffstoken über die erforderlichen Rollen verfügen, um auf die Endpunkte zugreifen zu können. Die erforderlichen Rollen sind in der Dokumentation jedes Endpunkts aufgeführt.

OpenAPI-Spezifikation​

Die Endpunkte dieser REST-API sind auch als OpenAPI-Dokument beschrieben, das zum Generieren von API-Clients oder zum Import der API in Tools wie Postman verwendet werden kann. Das OpenAPI-Dokument ist ohne Autorisierung verfügbar:

curl -X GET "https://app-stable.loyjoy.com/api/openapi.json"

Prozesse-(KI-Agenten)-API​

In LoyJoy werden KI-Agenten als BPMN-Prozesse implementiert. Die API bezeichnet KI-Agenten daher als Prozesse.

Alle Prozesse (KI-Agenten) als JSON auflisten​

owner editor processes_editor processes_viewer

Gibt eine JSON-Liste aller Prozesse (KI-Agenten) im Tenant zurück.

curl -X GET "https://app-stable.loyjoy.com/api/processes" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Einen Prozess (KI-Agenten) als JSON abrufen​

owner editor processes_editor processes_viewer

Gibt eine JSON-Darstellung der aktuellen, möglicherweise unveröffentlichten Version des Prozesses (KI-Agenten) im Tenant zurück.

curl -X GET "https://app-stable.loyjoy.com/api/processes/<PROCESS_ID>" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Einen Prozess (KI-Agenten) als XML abrufen​

owner editor processes_editor processes_viewer

Gibt eine XML-Darstellung des Prozesses (KI-Agenten) im Tenant zurück. Dies ist die XML-Serialisierung, wie sie von der LoyJoy-Laufzeitengine ausgeführt wird. Bitte beachten Sie, dass sich das XML-Schema in Zukunft mit der Weiterentwicklung der LoyJoy-Funktionalität ändern kann, d. h. das XML-Schema stellt keine API dar. Wenn der KI-Agent nicht veröffentlicht ist, erhalten Sie eine 404 Not Found.

curl -X GET "https://app-stable.loyjoy.com/api/processes/xml/<PROCESS_ID>" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/xml"

Einen Prozess (KI-Agenten) starten​

owner editor

Startet einen Prozess (KI-Agenten) programmatisch. Dieser Aufruf kann optional Variablen aufnehmen und gibt anschließend die resultierenden Variablen zurück. Die Prozessinstanz hält an, wenn der Prozess (KI-Agent) eine Benutzereingabe erwartet. Wenn der Prozess (KI-Agent) z. B. ein Weiter-Prozessmodul enthält, hält er bei der Weiter-Frage an. Der Stillstand kann vermieden werden, indem nur Prozessmodule verwendet werden, die keine Benutzerinteraktion erfordern.

curl -X POST "https://app-stable.loyjoy.com/api/processes/start/<PROCESS_ID>" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json" \
-d '{ "variables": { "some_var": { "value": "some_value" } } }'

Home-Views-API​

Alle Views als JSON auflisten​

owner editor processes_editor processes_viewer

Gibt eine JSON-Liste aller Views im Tenant zurück.

curl -X GET "https://app-stable.loyjoy.com/api/views" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Eine Home View als JSON abrufen​

owner editor processes_editor processes_viewer

Gibt eine JSON-Darstellung der View im Tenant zurück.

curl -X GET "https://app-stable.loyjoy.com/api/views/<VIEW_ID>" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Eine Home View als XML abrufen​

owner editor processes_editor processes_viewer

Gibt eine XML-Darstellung der View im Tenant zurück. Bitte beachten Sie, dass sich das XML-Schema in Zukunft mit der Weiterentwicklung der LoyJoy-Funktionalität ändern kann, d. h. das XML-Schema stellt keine API dar.

curl -X GET "https://app-stable.loyjoy.com/api/views/xml/<VIEW_ID>" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/xml"

Chunks-API​

Nach Chunks suchen​

owner editor knowledge_editor knowledge_exporter knowledge_viewer

Sucht nach bis zu 100 Chunks anhand eines bestimmten Suchbegriffs.

curl -X POST "https://app-stable.loyjoy.com/api/chunks/search" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json" \
-d '{ "query": "What is LoyJoy?" }'
curl -X POST "https://app-stable.loyjoy.com/api/chunks/search" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json" \
-d '{ "query": "What is LoyJoy?", "folders": ["folder1"], "max_chunks": 10 }'

Kataloge-API für die Wissensdatenbank​

Alle Kataloge als JSON auflisten​

owner editor knowledge_editor knowledge_exporter knowledge_viewer

Gibt eine JSON-Liste aller Kataloge im Tenant zurück.

curl -X GET "https://app-stable.loyjoy.com/api/catalogs" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Einen Katalog als JSON abrufen​

owner editor knowledge_editor knowledge_exporter knowledge_viewer

Gibt eine JSON-Darstellung des Katalogs im Tenant zurück.

curl -X GET "https://app-stable.loyjoy.com/api/catalogs/<CATALOG_ID>" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Einen Katalog als XML abrufen​

owner editor knowledge_exporter

Gibt eine XML-Darstellung des Katalogs im Tenant zurück. Bitte beachten Sie, dass sich das XML-Schema in Zukunft mit der Weiterentwicklung der LoyJoy-Funktionalität ändern kann, d. h. das XML-Schema stellt keine API dar.

curl -X GET "https://app-stable.loyjoy.com/api/catalogs/xml/<CATALOG_ID>" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/xml"

Einen Katalog löschen​

owner editor knowledge_editor

Löscht den Katalog im Tenant.

curl -X DELETE "https://app-stable.loyjoy.com/api/catalogs/<CATALOG_ID>" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Einen Katalog posten​

owner editor knowledge_editor

Postet eine JSON-Darstellung eines Katalogs in den Tenant.

curl -X POST "https://app-stable.loyjoy.com/api/catalogs" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json" \
-d '{ "name": "Some Catalog" }'

Artikel-API​

Alle Artikel eines Katalogs als JSON auflisten​

owner editor knowledge_editor knowledge_exporter knowledge_viewer

Gibt eine JSON-Liste aller Artikel eines Wissens-Katalogs im Tenant zurück.

curl -X GET "https://app-stable.loyjoy.com/api/articles?catalog_id=<CATALOG_ID>" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Einen Artikel eines Katalogs als JSON abrufen​

owner editor knowledge_editor knowledge_exporter knowledge_viewer

Gibt eine JSON-Darstellung des Artikels eines Katalogs im Tenant zurück.

curl -X GET "https://app-stable.loyjoy.com/api/articles/<ARTICLE_ID>?catalog_id=<CATALOG_ID>" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Einen Artikel eines Katalogs löschen​

owner editor knowledge_editor

Löscht den Artikel eines Katalogs im Tenant.

vorsicht

Bitte beachten Sie, dass Sie nur 1 Artikel pro Sekunde und Katalog löschen können. Das bedeutet, dass Sie Ihren Client drosseln müssen, da die API sonst nach mehreren Schreibvorgängen HTTP-Status-500-Fehler wirft.

curl -X DELETE "https://app-stable.loyjoy.com/api/articles/<ARTICLE_ID>?catalog_id=<CATALOG_ID>" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Einen Artikel eines Katalogs als JSON posten​

owner editor knowledge_editor

Postet eine JSON-Darstellung des Artikels in einen Katalog im Tenant.

vorsicht

Bitte beachten Sie, dass Sie nur 1 Artikel pro Sekunde und Katalog schreiben können. Das bedeutet, dass Sie Ihren Client drosseln müssen, da die API sonst nach mehreren Schreibvorgängen HTTP-Status-500-Fehler wirft.

curl -X POST "https://app-stable.loyjoy.com/api/articles?catalog_id=<CATALOG_ID>" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json" \
-d '{ "name": "Some Article", "text": { "de": "Some German Text", "de-x-formal": "Some German Formal Text", "en": "Some English Text" }, "title": { "de": "Some German Title" }, "source_url": "https://www.example.org" }'

Quellen-API​

Diese Endpunkte bieten Lese- und Schreibzugriff auf Quellen, die vom AI-Knowledge-Modul verwendet werden. Sie ermöglichen es Ihnen, Quellen wie Websites oder Dateien zur Wissensdatenbank hinzuzufügen, sie abzurufen und zu löschen. Quellen können über öffentlich zugängliche URLs hinzugefügt oder durch Hochladen von Dateien erstellt werden. Wenn Sie eine große Anzahl von Dateien programmatisch hochladen möchten, gibt es ein Beispiel-Skript.

Darüber hinaus ermöglicht die API auch, die Quellen nach einem Zeitplan oder bei Bedarf zu aktualisieren. Dazu können Sie einfach einige oder alle Ihrer Quellen löschen und dann erneut hinzufügen. Dies löst einen erneuten Crawl der Quelle aus.

Alle Quellen als JSON auflisten​

owner editor knowledge_editor knowledge_exporter knowledge_viewer

Gibt eine JSON-Liste aller Wissensquellen im Tenant zurück.

curl -X GET "https://app-stable.loyjoy.com/api/sources" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Alle hochgeladenen Quellen als JSON auflisten​

owner editor knowledge_editor knowledge_exporter knowledge_viewer

Gibt eine JSON-Liste aller Wissensquellen der Art Upload im Tenant zurück, d. h. Dateien, die als Quellen hochgeladen wurden. Schließt Wissensquellen anderer Arten wie URL aus.

curl -X GET "https://app-stable.loyjoy.com/api/sources/upload" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Eine Quelle als JSON abrufen​

owner editor knowledge_editor knowledge_exporter knowledge_viewer

Gibt eine JSON-Darstellung der Quelle im Tenant zurück.

curl -X GET "https://app-stable.loyjoy.com/api/sources/<SOURCE_ID>" \
-H "Authorization: Bearer <BEARER_TOKEN>"
-H "Content-Type: application/json"

Eine Quelle löschen​

owner editor knowledge_editor

Löscht die Quelle im Tenant.

curl -X DELETE "https://app-stable.loyjoy.com/api/sources/<SOURCE_ID>" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Alle Quellen löschen​

owner editor knowledge_editor

Löscht alle Quellen im Tenant.

gefahr

Dies löscht dauerhaft alle Quellen im Tenant.

curl -X DELETE "https://app-stable.loyjoy.com/api/sources" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Jede Quelle benötigt ca. 500ms zum Löschen. Wenn Sie mehrere hundert oder tausend Quellen löschen möchten, kann der API-Aufruf am Load Balancer ein Timeout auslösen. Im Hintergrund sollte das Löschen jedoch fortgesetzt werden. Bei einem Timeout versuchen Sie es bitte nicht direkt nach dem Timeout erneut, sondern warten Sie mehrere Minuten bis zum nächsten Versuch. Sie können den Status des Löschvorgangs prüfen, indem Sie den Endpunkt GET /sources aufrufen und die resultierenden Einträge zählen.

Alle Quellen-Uploads löschen​

owner editor knowledge_editor

Löscht alle Quellen der Art Upload im Tenant, d. h. alle als Quellen hochgeladenen Dateien.

gefahr

Dies löscht dauerhaft alle Quellen der Art Upload im Tenant.

curl -X DELETE "https://app-stable.loyjoy.com/api/sources/upload" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Jede Quelle benötigt ca. 500ms zum Löschen. Wenn Sie mehrere hundert oder tausend Quellen löschen möchten, kann der API-Aufruf am Load Balancer ein Timeout auslösen. Im Hintergrund sollte das Löschen jedoch fortgesetzt werden. Bei einem Timeout versuchen Sie es bitte nicht direkt nach dem Timeout erneut, sondern warten Sie mehrere Minuten bis zum nächsten Versuch. Sie können den Status des Löschvorgangs prüfen, indem Sie den Endpunkt GET /sources/upload aufrufen und die resultierenden Einträge zählen.

Eine Quelle posten​

owner editor knowledge_editor

Postet eine JSON-Darstellung einer Quelle in den Tenant. Das Feld type kann einen der Werte CSV, DOCX, HTML, MD, PDF, PPTX, TXT, XLSX oder ZIP haben.

curl -X POST "https://app-stable.loyjoy.com/api/sources" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json" \
-d '{ "type": "HTML", "url": "https://www.example.org/example.html" }'

Ordner-Parameter​

Sie können dem Upload optional auch einen Ordnernamen hinzufügen.

curl -X POST "https://app-stable.loyjoy.com/api/sources" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json" \
-d '{ "type": "HTML", "url": "https://www.example.org/example.html", "folder": "name" }'

Eine Quellen-Upload posten​

owner editor knowledge_editor

Postet eine Quelldatei in den Tenant. Vergleichbar mit dem Hochladen einer Quelldatei im LoyJoy Manager. Gültige Inhaltstypen sind text/csv, application/vnd.openxmlformats-officedocument.wordprocessingml.document, text/html, text/markdown, application/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation, text/plain, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet und application/xml (wird als Sitemap importiert). ZIP-Dateien werden über die API nicht unterstützt.

vorsicht

Limit für Upload-Größe: Über die API können nur Dateien bis zu 32 MB hochgeladen werden. Größere Dateien werden nicht unterstützt.

curl -X POST "https://app-stable.loyjoy.com/api/sources/upload" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
--form 'file=@sample.pdf'

URL-Parameter​

Optional können Sie auch eine URL hinzufügen, die bei der Anzeige der Quelle im Chat referenziert werden soll. Der hinzugefügte URL-Parameter muss URL-codiert sein.

curl -X POST "https://app-stable.loyjoy.com/api/sources/upload?url=https%3A%2F%2Fwww.example.org%2Fsample.pdf" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
--form 'file=@sample.pdf'
tipp

Wenn Sie curl zum Hochladen einer Datei verwenden, entfernen Sie das @ vor dem Dateinamen nicht, sonst schlägt der Datei-Upload fehl.

Ordner-Parameter​

Optional können Sie dem Upload auch einen Ordnernamen hinzufügen. Der hinzugefügte Ordner-Parameter muss URL-codiert sein.

curl -X POST "https://app-stable.loyjoy.com/api/sources/upload?folder=name" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
--form 'file=@sample.pdf'

Produkte-API​

Diese Endpunkte bieten Lese- und Schreibzugriff auf Produkte, die von Datenbank-Connectoren im Produkt-Feed-Modul verwendet werden. Sie ermöglichen es Ihnen, Informationen über Ihre Produkte programmatisch bereitzustellen und sie zu speichern, abzurufen oder zu löschen.

Postman-Collection

Alle Produkte als JSON auflisten​

owner editor products_editor products_viewer

Gibt eine JSON-Liste aller Produkte im Tenant zurück.

curl -X GET "https://app-stable.loyjoy.com/api/products" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Ein Produkt als JSON abrufen​

owner editor products_editor products_viewer

Gibt eine JSON-Darstellung des Produkts im Tenant zurück.

curl -X GET "https://app-stable.loyjoy.com/api/products/<PRODUCT_ID>" \
-H "Authorization: Bearer <BEARER_TOKEN>"
-H "Content-Type: application/json"

Ein Produkt löschen​

owner editor products_editor

Löscht das Produkt im Tenant.

curl -X DELETE "https://app-stable.loyjoy.com/api/products/<PRODUCT_ID>" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Alle Produkte löschen​

owner editor products_editor

Löscht alle Produkte im Tenant.

gefahr

Dies löscht dauerhaft alle Produkte im Tenant.

curl -X DELETE "https://app-stable.loyjoy.com/api/products" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Ein Produkt posten​

owner editor products_editor

Postet eine JSON-Darstellung eines Produkts in den Tenant.

curl -X POST "https://app-stable.loyjoy.com/api/products" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
      "title": "Some Product",
      "locale": "en",
      "description": "Some Product description",
      "header": "Some header",
      "price": "price",
      "image_url": "https://example.com/some_image.png",
      "url": "https://example.com/some_product",
      ....
    }'

Gibt das erstellte Produkt als JSON zurück.

Beachten Sie, dass die Felder title und locale Pflichtfelder sind und im JSON vorhanden sein müssen. Alle anderen Felder sind optional und können den Chat-KI-Agenten Ihrer Kunden erweitern. Darüber hinaus können Sie eigene benutzerdefinierte Felder setzen, indem Sie Schlüssel-Wert-Paare im JSON angeben. Diese Felder werden auf der ersten Ebene zusammen mit den anderen Feldern gespeichert. Dies ermöglicht effiziente SQL-Abfragen und die Nutzung Ihres eigenen Schemas zum Filtern Ihrer Produkte im Chat. Wenn Sie z. B. ein Kategorienfeld Ihres Produkts verwenden, senden Sie das folgende JSON:

{
  "category": "my_category",
  "title": "Some Product",
  "locale": "en"
}

Dann können Sie Ihre Produkte mit SQL filtern.

SELECT * FROM products WHERE category = 'my_category';

Ein Produkt upserten​

owner editor products_editor

Alternativ zum Posten eines Produkts können Sie ein Produkt auch upserten. Das bedeutet, dass das Produkt aktualisiert wird, wenn es bereits existiert, oder erstellt wird, wenn es nicht existiert.

curl -X POST "https://app-stable.loyjoy.com/api/products/upsert" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
      "id": "4566be0c-1ab6-4e63-98c7-d8ad9695e11f",
      "title": "Some Product",
      "locale": "en",
      "description": "Some Product description",
      "header": "Some header",
      "price": "price",
      "image_url": "https://example.com/some_image.png",
      "url": "https://example.com/some_product",
      ....
    }'

Gibt das erstellte oder aktualisierte Produkt als JSON zurück.

Ein Produkt per reference_id upserten​

owner editor products_editor

Alternativ zum Posten eines Produkts können Sie ein Produkt auch per reference_id upserten. Das bedeutet, dass das Produkt aktualisiert wird, wenn bereits ein Produkt mit der angegebenen reference_id existiert, oder erstellt wird, wenn es nicht existiert. Eine reference_id kann eine ID aus Ihrem eigenen System sein.

curl -X POST "https://app-stable.loyjoy.com/api/products/upsert_by_reference_id" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
      "reference_id": "some_reference_id_123",
      "title": "Some Product",
      "locale": "en",
      "description": "Some Product description",
      "header": "Some header",
      "price": "price",
      "image_url": "https://example.com/some_image.png",
      "url": "https://example.com/some_product",
      ....
    }'

Gibt das erstellte oder aktualisierte Produkt bzw. die Produkte als JSON-Array zurück. Eine reference_id kann mit mehreren Produkten übereinstimmen; in diesem Fall werden alle aktualisiert und zurückgegeben.

Teilnahme-Gewinner-API​

Alle Teilnahme-Gewinner eines Gewinnspiels als JSON abrufen​

owner editor data_exporter

Gibt eine JSON-Liste aller Teilnahme-Gewinner eines Gewinnspiels im Tenant zurück.

curl -X GET "https://app-stable.loyjoy.com/api/participation_winners/by_giveaway?giveaway_id=<GIVEAWAY_ID>" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Teilnahme-Gewinner als JSON erstellen​

owner editor data_editor

Erstellt Teilnahme-Gewinner für ein Gewinnspiel im Tenant. Der amount ist die Anzahl der zu erstellenden Gewinner. Die bpmn_process_id ist die ID des Prozesses, der das Gewinnspiel enthält. Die giveaway_id ist die ID des Gewinnspiels, für das die Gewinner erstellt werden. Es müssen genügend Teilnahmen im Gewinnspiel vorhanden sein, um die Gewinner zu erstellen.

curl -X POST "https://app-stable.loyjoy.com/api/participation_winners" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json" \
-d '{ "amount": <AMOUNT>, "bpmn_process_id": "00000000-0000-0000-0000-000000000000", "giveaway_id": "00000000-0000-0000-0000-000000000000" }'

Variablen-API​

Die Variablen-API ermöglicht Ihnen, Prozessvariablen zu lesen und zu schreiben. Prozessvariablen werden verwendet, um Daten während der Ausführung eines Prozesses zu speichern.

Standardmäßig sind die Endpunkte zum Auflisten von Variablen aufgrund des standardmäßigen Sicherheitsschutzes deaktiviert. Wenden Sie sich bei Bedarf bitte an den LoyJoy-Support, um sie in Ihrem Tenant zu aktivieren. Das Posten einer Variable und das Abrufen der zu einer Variable gehörenden Daten sind unabhängig von dieser Einstellung verfügbar.

Alle Variablen als JSON abrufen​

owner editor data_editor data_exporter data_viewer

Gibt eine JSON-Liste aller Variablen im Tenant zurück. Standardmäßig ist der Endpunkt zum Abrufen von Variablen aufgrund des standardmäßigen Sicherheitsschutzes deaktiviert. Wenden Sie sich bei Bedarf bitte an den LoyJoy-Support, um ihn in Ihrem Tenant zu aktivieren.

curl -X GET "https://app-stable.loyjoy.com/api/variables" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Die Liste der Variablen kann über das Feld created_at mit den Query-Parametern created_at_min und created_at_max als Unix-Zeitstempel in Millisekunden gefiltert werden. Beide Grenzen sind exklusiv.

curl -X GET "https://app-stable.loyjoy.com/api/variables?created_at_min=1748105636166" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"
curl -X GET "https://app-stable.loyjoy.com/api/variables?created_at_max=1748105636166" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Alle Variablen nach Prozess-ID als JSON abrufen​

owner editor data_editor data_exporter data_viewer

Gibt eine JSON-Liste aller Variablen eines Prozesses im Tenant zurück. Standardmäßig ist der Endpunkt zum Abrufen von Variablen aufgrund des standardmäßigen Sicherheitsschutzes deaktiviert. Wenden Sie sich bei Bedarf bitte an den LoyJoy-Support, um ihn in Ihrem Tenant zu aktivieren.

curl -X GET "https://app-stable.loyjoy.com/api/variables/by_bpmn_process?bpmn_process_id=<PROCESS_ID>" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Die Liste der Variablen kann über das Feld created_at mit den Query-Parametern created_at_min und created_at_max als Unix-Zeitstempel in Millisekunden gefiltert werden. Beide Grenzen sind exklusiv.

curl -X GET "https://app-stable.loyjoy.com/api/variables/by_bpmn_process?bpmn_process_id=<PROCESS_ID>&created_at_min=1748105636166" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"
curl -X GET "https://app-stable.loyjoy.com/api/variables/by_bpmn_process?bpmn_process_id=<PROCESS_ID>&created_at_max=1748105636166" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json"

Eine Variable als JSON posten​

owner editor data_editor

Postet eine JSON-Darstellung einer Variable in den Tenant. Die Felder key, value, scope (customer oder process), bpmn_process_id, process_instance_id, device_id und expires_at sind erforderlich.

curl -X POST "https://app-stable.loyjoy.com/api/variables" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json" \
-d '{ "key": "some_key", "value": "some_value", "scope": "process", "bpmn_process_id": "00000000-0000-0000-0000-000000000000", "device_id": "00000000-0000-0000-0000-000000000000", "email": "user@example.org", "expires_at": 1703372400000, "process_instance_id": "00000000-0000-0000-0000-000000000000" }'

Daten abrufen, die zu einer Variable gehören​

owner editor data_editor data_exporter data_viewer

Eine Prozessvariable kann eine Datei enthalten, z. B. bei einer Datei-Upload-Frage im Fragebogen. Sie können den Inhalt einer solchen Datei über die Variablen-Daten-API herunterladen.

curl "https://app-stable.loyjoy.com/api/variables/data/<VARIABLE_ID>" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
--output test.file

Web-Benachrichtigungs-API​

Eine Web-Benachrichtigung als JSON posten​

owner editor data_editor

Postet eine JSON-Darstellung einer Web-Benachrichtigung. Die Benachrichtigung wird auf der Home View der angegebenen Geräte-ID angezeigt, wenn ein Benachrichtigungs-Widget auf der Home View enthalten ist. Die Geräte-ID kann mit dem Funktionsaufruf deviceId() ermittelt werden.

curl -X POST "https://app-stable.loyjoy.com/api/web_notifications" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json" \
-d '{ "body": "Some Body", "title": "Some Title", "device_id": "00000000-0000-0000-0000-000000000000", "due_at": 1682004002683, "expires_at": 1703372400000, "icon_url": "http://placekitten.com/200/300", "jump_bpmn_process_id": "00000000-0000-0000-0000-000000000000", "url": "https://www.example.org" }'

Completions-API​

Verwenden Sie diesen Endpunkt, um einen Completion-Text für einen bestimmten veröffentlichten Prozess (KI-Agenten) zu erzeugen.

Eine Completion erstellen​

owner editor

Erstellt eine Completion für einen Prozess (KI-Agenten) und gibt erzeugten Text als JSON zurück.

curl -X POST "https://app-stable.loyjoy.com/api/completions/<PROCESS_ID>" \
-H "Authorization: Bearer <BEARER_TOKEN>" \
-H "Content-Type: application/json" \
-d '{ "text": "I need a short product recommendation", "locale": "en" }'

Felder des Anfragetexts:

  • text (erforderlich): Eingabetext für die Completion. Darf nicht leer sein.
  • locale (optional): Locale, die für die Erzeugung der Completion verwendet wird, z. B. en oder de.

Erfolgreiche Antwort (200):

{
  "text": "Based on your request, here is a short recommendation ..."
}

Mögliche Validierungsfehler (400):

  • Fehlende oder ungültige Prozess-ID im URL-Pfad.
  • Fehlender oder leerer text im Anfragetext (text must be not null in JSON).