Methoden der Odoo API-Integration im Überblick

Welche Methoden gibt es für die Odoo API-Integration?

Odoo unterstützt drei zentrale Technologien für die Integration:

1. RPC (Remote Procedure Call): Die native API für direkten Funktionszugriff.
2. REST API: Die standardisierte, webfreundliche Schnittstelle für gängige Anwendungsfälle.
3. Queued Middleware: Der nachrichtenbasierte Ansatz für skalierbare Datenflüsse.

Jede Methode hat spezifische Stärken und Nachteile, die von den beteiligten Systemen, der Art des Datenflusses und den Echtzeit-Anforderungen Ihrer Anwendung abhängen. 

Diese Methoden lassen sich auch kombinieren, z. B. REST für öffentliche APIs und RPC für interne Jobs. Für KI-Assistenten wie Claude oder ChatGPT bietet Odoo 20 einen weiteren Weg: einen nativen MCP-Server.

Was ist die externe API von Odoo (JSON-2 und RPC)?

Odoo unterstützt nativ eine RPC (Remote Procedure Call)-Schnittstelle, die direkte Methodenaufrufe über JSON oder XML ermöglicht. 

Seit Odoo 19 ist die JSON-2 API der Standard: Sie senden per POST einen JSON-Body mit einem API-Key als Bearer-Token, etwa um die Odoo-Methode search_read unter /json/2/res.partner/search_read aufzurufen. Die älteren XML-RPC- und JSON-RPC-Endpunkte (/xmlrpc, /xmlrpc/2, /jsonrpc) sind veraltet und sollen mit Odoo 22 (Herbst 2028) bzw. Odoo Online 21.1 (Winter 2027) entfernt werden. 

Der RPC-Ansatz erlaubt einen tiefen Zugriff auf Odoos Kernfunktionen und ist die am engsten integrierte Methode der Plattform.

Vorteile:

• Ideal für schnelle Interaktionen mit minimalem Overhead, da sie leichtgewichtig und effizient ist.
• Unterstützt alle internen Odoo-Methoden ohne zusätzliche Konfiguration und ermöglicht so vollen Systemzugriff.

Nachteile:

• Arbeitet auf Funktionsebene statt mit strukturierten Ressourcen: Sie rufen Backend-Methoden wie create, write oder search_read direkt auf, statt mit Standard-REST-Ressourcen wie /products oder /customers zu arbeiten
• Sie ist weniger verbreitet und bietet nicht die universelle Standardisierung von REST oder GraphQL.
• Jeder JSON-2-Aufruf läuft in einer eigenen Datenbanktransaktion, mehrere Aufrufe lassen sich also nicht zu einer atomaren Operation verketten.

Am besten geeignet für: Interne System-Integrationen und performanzkritische Aufgaben, bei denen tiefer Zugriff nötig ist. 

Hat Odoo eine REST API?

Die RESTful API in Odoo folgt den gängigen Webstandards und ermöglicht die Interaktion mit Odoo-Daten über bekannte HTTP-Methoden wie GET, POST, PUT und DELETE. 

Sie ist eine weit verbreitete Schnittstelle und ideal für die Anbindung externer Plattformen oder Services.

Odoo enthält standardmäßig keine native REST API, daher nutzen viele Implementierungen Community-Module oder individuelle Controller, um RESTful-Endpunkte bereitzustellen.

Vorteile:

• Standardisiert, weit verbreitet und von nahezu jeder modernen Programmiersprache unterstützt.
• Organisiert Daten in klaren Typen (etwa Produkte oder Aufträge), sodass sich Ihr System später leichter verwalten und skalieren lässt.
• REST-Client-Bibliotheken gibt es für die meisten Frameworks, da das Ökosystem breit unterstützt wird.
• REST APIs lassen sich leichter dokumentieren und testen, etwa mit Tools wie Postman oder Swagger.

Nachteile:

• REST-Aufrufe bringen zusätzliche Metadaten mit, die die Verarbeitung verlangsamen können.
• Weniger effizient bei komplexen Anwendungsfällen; die Performance kann leiden, wenn viele verkettete API-Aufrufe nötig sind.
• Nur HTTP, ohne integrierte Unterstützung für alternative Transportwege wie WebSockets.
• Zustandslosigkeit ist eine typische REST-Einschränkung und kann zu wiederholten Aufrufen führen, z. B. zum erneuten Abrufen von Authentifizierungs- oder Benutzerdaten.

Am besten geeignet für: Kundenportale, mobile Anwendungen und die Anbindung von Drittanbieter-Services, bei denen universelle Kompatibilität entscheidend ist.

Wann sollten Sie Queued Middleware mit Odoo einsetzen?

Bei Projekten mit hohen Datenvolumen oder asynchronen Kommunikationsanforderungen lässt sich Odoo über Queued-Middleware-Tools wie Kafka oder RabbitMQ integrieren, auch wenn Odoo diese Tools nicht nativ unterstützt.

Dieses Muster entkoppelt die beteiligten Systeme. Es gewährleistet eine fehlertolerante Kommunikation, selbst wenn ein System zeitweise nicht erreichbar ist.

Vorteile:

• Ermöglicht Kommunikation unabhängig von Antwortzeiten.
• Verarbeitet große Datenmengen und puffert Nachrichten, bis Ressourcen für die Verarbeitung frei sind.
• Hoch skalierbar und ausfallsicher: Nachrichten gehen selbst bei Systemausfällen nicht verloren.

Nachteile:

• Aufwändigeres Setup, eine separate Queueing-Infrastruktur ist erforderlich.
• Nicht in Echtzeit: Da die Verarbeitung asynchron erfolgt, sind Verzögerungen möglich.
• Erfordert wegen der Middleware-Abhängigkeiten ein sorgfältiges Setup und eine laufende Verwaltung der Message Broker

Am besten geeignet für: Datenintensive Prozesse wie Berichterstellung, Synchronisation großer Datenmengen oder zeitversetzte Massenoperationen.

Wie wählen Sie die richtige Methode für die Odoo API-Integration?  

Bei der Auswahl der optimalen API-Strategie für Ihr Odoo-Projekt sollten Sie folgende Faktoren berücksichtigen:

• Integrationspartner: Handelt es sich um ein internes Tool oder ein externes Drittsystem?
• Echtzeit-Anforderung: Benötigen Sie sofortige Übertragung oder ist eine verzögerte Verarbeitung akzeptabel?
• Datenvolumen: Synchronisieren Sie wenige Datensätze oder Tausende pro Stunde?
• Komplexität: Wünschen Sie eine standardisierte Plug-and-Play-Lösung oder eine hochgradig optimierte, kundenspezifische Implementierung?

Die Faustregel:

Bei der Wahl der passenden API-Verbindungsmethode in Odoo müssen Sie sich nicht strikt auf eine Technologie beschränken.

Oft kommt ein hybrider Ansatz zum Einsatz: Beispielsweise wird REST für öffentlich zugängliche Systeme genutzt, RPC für die Orchestrierung interner Backend-Prozesse und Queues für die ablaufintensive Hintergrundverarbeitung.

Bitte beachten Sie: Die externe API von Odoo ist nur im Custom-Tarif verfügbar, nicht in One App Free oder Standard. REST- und Middleware-Optionen hängen von Ihrer Odoo-Version oder individuellen Implementierungen ab.

Was sollten Sie vor dem Start einer Odoo API-Integration prüfen?

Klären Sie diese Punkte mit Ihrem Team oder Integrationspartner, bevor Sie mit der Entwicklung beginnen:

• Authentifizierung: Welche Strategie wird verwendet (Tokens, Session-basiert oder OAuth)?
• Fehlerbehandlung: Wie werden Fehler abgefangen und Wiederholungen (Retries) gehandhabt?
• Datenhoheit: Wer ist der Source of Truth für welches Datenfeld?
• Sicherheit: Sind die Endpunkte geschützt und die Daten verschlüsselt?
• Monitoring: Wie wird der API-Verkehr überwacht und die Fehlerrate protokolliert?

Eine gut vorbereitete Integration spart Zeit, reduziert Fehler und sorgt dafür, dass Ihre vernetzten Systeme zuverlässig und zukunftssicher bleiben.

Häufige Fragen zur Odoo API

Welche Methoden nutzt Odoo für die API-Integration? 

Odoo integriert sich über die externe API (seit Odoo 19 JSON-2; XML-RPC und JSON-RPC sind veraltet), über REST-Endpunkte aus individuellen oder Community-Modulen und über Queued Middleware wie RabbitMQ oder Kafka für hohe Datenvolumen. KI-Assistenten verbinden sich über den MCP-Server von Odoo 20.

Ist es einfach, Odoo per API mit anderer Software zu verbinden? 

Ja, wenn Ihr Tarif es umfasst. Die externe API von Odoo ist nur im Custom-Tarif verfügbar, nicht in One App Free oder Standard. Damit können Sie Odoo mit Tools wie Shopify oder CRM-Drittsystemen verbinden, um Workflows zu automatisieren und Daten ohne manuelle Eingabe zu synchronisieren.

Wie halte ich meine Odoo API-Verbindung sicher? 

Verwenden Sie pro Integration einen eigenen Odoo API-Key, der als Bearer-Token im Authorization-Header gesendet wird, niemals das Passwort eines Benutzers. Lassen Sie Integrationen als Bot-Benutzer mit nur den nötigen Zugriffsrechten laufen, verschlüsseln Sie den gesamten Datenverkehr per HTTPS und widerrufen Sie einen Key sofort, wenn ein Sicherheitsrisiko erkannt wird.

Ist XML-RPC in Odoo veraltet?

Ja. XML-RPC und JSON-RPC (/xmlrpc, /xmlrpc/2, /jsonrpc) sind seit Odoo 19 veraltet. Laut Odoo-Dokumentation werden sie mit Odoo 22 (Herbst 2028) bzw. Odoo Online 21.1 (Winter 2027) entfernt. Stellen Sie Ihre Integrationen bis dahin auf die JSON-2 API um, idealerweise im Rahmen Ihres Odoo-Upgrades.

Was ist die JSON-2 API von Odoo?

JSON-2 ist seit Odoo 19 die externe API von Odoo. Sie senden per POST einen JSON-Body an /json/2/model/method, z. B. /json/2/res.partner/search_read, mit einem API-Key als Bearer-Token im Authorization-Header. Jeder Aufruf läuft in einer eigenen Datenbanktransaktion, mehrere Aufrufe lassen sich also nicht atomar verketten.

Welchen Odoo-Tarif brauche ich für den API-Zugriff?

Sie benötigen den Custom-Tarif. Laut Odoo-Dokumentation ist der Datenzugriff über die externe API nur in Custom-Tarifen verfügbar, nicht in One App Free oder Standard. Wenn Sie den Standard-Tarif nutzen und Integrationen planen, kalkulieren Sie den Wechsel zu Custom vor Entwicklungsbeginn ein.

Wie verbinden sich KI-Tools wie Claude oder ChatGPT mit Odoo?

Über MCP (Model Context Protocol). Odoo 20 bringt einen nativen MCP-Server mit einem /mcp-Endpunkt mit, der standardmäßig fünf Tools mit reinem Lesezugriff bietet; Schreibaktionen muss ein Administrator freischalten. Er nutzt eigene MCP-API-Keys und setzt die Zugriffsrechte des Benutzers durch. Mehr zum Odoo MCP-Server.