REST API
Unsere REST-API stellt versionierte HTTP-Endpoints mit vorhersehbaren Ressourcen-URLs und RFC-konformen Fehlerantworten bereit. Verwenden Sie sie für klassische CRUD-Integrationen, Webhooks und Hintergrund-Jobs.
Endpoints
- Produktion:
https://api.tourfold.com/api/v2/
Referenz
- OpenAPI:
/openapi(YAML-Spezifikation herunterladen) - Plugin-APIs: Die JSON-Spezifikation jedes Plugins findest du unter Einstellungen → Allgemein → Funktionen & Plugins. Siehe API-Spezifikationen für Plugins.
Startpunkte
- Konventionen:
Grundlagenbehandelt Benennungen, Datumsformate, Paginierungs-Cursor und URL-Struktur. - Authentifizierung:
Autherklärt OAuth2-/OIDC-Access-Token und Servicekonten für Server-zu-Server-Integrationen. - Fehler: Gemeinsame
Fehlerseitefür REST und GraphQL.
Allgemeine Leitfäden
Objekte und DatensätzePaginierung, Sortierung & FilterungVerschachtelte RessourcenRate LimitingTracing
Definitionen abfragen
GET /api/v2/definitions/all listet sichtbare konkrete Objekt-, Fahrzeug- und Aufgabendefinitionen
sowie unterstützte native Projektionen. Interne Fahrzeug- und Aufgabenwurzeln sind ausgeschlossen.
GET /api/v2/definitions/all/{definition_ref} akzeptiert einen Slug oder eine UUID; unbekannte und
verborgene Definitionen liefern 404. page und size (1–100) steuern die Seitenauswahl. Die
Berechtigungsprüfung erfolgt vor der Sortierung nach Slug und UUID und vor der Seitenauswahl.
Detail-, Listen- und Schreibantworten der jeweiligen Ressource und die gemeinsame Abfrage verwenden
für denselben Aufrufer und dieselbe Revision die gleiche Definitionsdarstellung.
resource_type ist object, vehicle, task oder ein registrierter nativer Schlüssel. Die
Familienzuordnung bleibt intern; execution_type beschreibt das Aufgabenverhalten. definition_id
eines Datensatzes bezeichnet weiterhin seine gewählte Definition.
Die Metadatenabfrage erteilt keinen Datensatzzugriff. Bearbeiten Sie Definitionen über die Objekt-, Fahrzeug- oder Aufgaben-API. GraphQL behält seine eigene Schema- und Verbindungsdarstellung.
Beispielanfrage
curl -X GET "https://api.tourfold.com/api/v2/areas" \
-H "Authorization: Bearer YOUR_TOKEN"