Mit der App-Tools-API bindest du SynCore an andere Systeme an: Daten lesen, Datensätze anlegen oder ändern, Abläufe anstoßen. Die API nutzt dieselben Aktionen wie SynCore selbst und prüft dieselben Rechte wie bei einem Benutzer in der Oberfläche.
So ist die API aufgebaut
- Ein Endpunkt:
/api/app-tools.GETliefert den Katalog der für dich erlaubten Aktionen, der sogenannten Tools.POSTführt genau eines davon aus. - Ein Schlüssel je Integration: Der API-Key gehört zu einem Mandanten und handelt als ein technischer Benutzer, der Actor-User. Was dieser Benutzer in SynCore sehen und ändern darf, darf auch die Integration.
- Ein Katalog, der sich anpasst: Welche Tools es gibt, hängt von den aktiven Apps, den Rollen und den Datenbereichen des Actor-Users ab. Eine feste, für alle gültige Tool-Liste gibt es nicht.
- Eine Spur im Audit-Log: Standardmäßig steht jeder ausgeführte Aufruf mit Mandant, Actor-User, Tool und Ergebnis im Audit-Log. Wie die API geschützt ist, steht unter Sicherheit der API.
In dieser Reihenfolge vorgehen
- Technischen Benutzer mit knappen Rechten anlegen und API-Key beantragen: API-Keys, Scopes und Berechtigungen
- Ersten Katalog abrufen und ein lesendes Tool ausführen: API-Quickstart
- Anfragen und Fehlerfälle gezielt testen: API-Anfragen sicher testen
- Felder, Antworten, Statuscodes und Limits nachschlagen: App-Tools-API Referenz
- Tools einer App mit Eingabefeldern und Rechten nachschlagen: Referenz nach App
Für einige feste Aufgaben, etwa ein Anmeldeformular auf deiner Website oder Bestellungen aus einem Shop, gibt es eigene Endpunkte mit eigenem Scope: Spezialanbindungen neben den App-Tools.
Mit KI-Assistenten arbeiten
Claude, Cursor, VS Code und andere Clients verbindest du direkt über MCP mit deiner Instanz. Der Assistent nutzt dann dieselben Tools mit denselben Rechten wie die API, auf Wunsch im Code-Mode mit Programmen statt Einzelaufrufen. Alles dazu steht in der Rubrik MCP & KI-Assistenten.
Damit ein Assistent die Dokumentation kennt, gib Claude, ChatGPT oder deinem eigenen Assistenten die Adresse https://support.unitedsynergy.com/api/llms.txt. Darin stehen alle Artikel zur API und zu MCP und die Referenz aller App-Tools als Klartext. Jede Seite gibt es auch einzeln: Häng llms.txt an ihre Adresse an, zum Beispiel /api/referenz/crm/llms.txt. Eine Übersicht aller Dateien steht unter /llms.txt.
Den API-Key gibst du dem Assistenten nicht in den Chat. Er gehört in die Umgebung, in der die Aufrufe laufen.
Tools für besonders geschützte Daten der Datenklasse D, zum Beispiel Gesundheitsdaten, bietet die API nicht an. Pro Schlüssel gilt ein Anfragelimit, die Werte stehen in der Referenz.
Statuscodes, Meldungen und ihre häufigsten Ursachen findest du unter Wenn eine API-Anfrage scheitert.