Zum Inhalt springen
Start » REST-API

REST-API

REST-API

Jede odoso-Installation bringt eine vollständige REST-API mit. Alles, was die Weboberfläche und die mobile App tun, läuft über dieselben Endpunkte — es gibt keine verborgene Schnittstelle, die nur den eigenen Anwendungen offensteht.

Adresse und Beschreibung

Die API liegt unter dem Namensraum odoso/v1 auf deiner eigenen Domain:

https://deine-domain.de/wp-json/odoso/v1/

Eine maschinenlesbare Beschreibung aller Endpunkte samt Parametern liefert die Installation selbst aus:

https://deine-domain.de/wp-json/odoso/v1/openapi.json

Damit lassen sich Clients generieren oder die Schnittstelle in Werkzeugen wie Postman oder Insomnia erkunden.

Anmeldung

Zwei Wege stehen offen:

  • Bearer-Token — ein persönlicher Schlüssel, den du in den Einstellungen erzeugst und im Kopf Authorization: Bearer … mitschickst. Er lässt sich jederzeit einzeln widerrufen.
  • Projekt-Eingangsadresse — eine eigene Adresse pro Projekt, über die externe Systeme Aufgaben einliefern können, ohne Zugang zum Rest der Installation zu bekommen.

Es gelten Ratengrenzen je Token, je Person und je IP-Adresse. Sie sind großzügig bemessen und sollen nur verhindern, dass ein fehlerhaftes Skript eine Installation lahmlegt.

Verfügbarkeit

Lesende Zugriffe stehen jeder Installation offen. Das Erzeugen eigener API-Tokens sowie Integrationen sind Bestandteil der Unlimited-Lizenz.