MuK REST API for Odoo
Stellt eine REST API für den Odoo Server bereit.
Technischer Name: muk_rest
Repository: https://gitlab.com/mint-system/odoo-apps-partner/-/tree/16.0/muk_rest
Odoo App Store: https://apps.odoo.com/apps/modules/16.0/muk_rest/\
Verwendung
API-Dokumentation anzeigen
Klicken Sie auf Einstellungen > API > Documentation > Endpoints. Es wird ein neuer Tab geöffnet mit dem Pfad /rest/docs. Auf dieser Seite werden die REST APIs des Odoo Server beschrieben.
API-Verbindung authorisieren
Klicken Sie auf Einstellungen > API > Documentation > Endpoints und wählen Sie Authorize. Geben Sie ihre Anmeldeinformationen ein und wählen Sie Authorize. Bestätigen Sie den Vorgang mit Close.
API-Pfad testen
Um Anfragen auszuführen, mmüssen Sie die API-Verbindung authorisieren. Danach rufen Sie den Eintrag mit Pfad /api/v2/read auf und klicken auf Try it out. Passen Sie optional die Parameter an und verschicken Sie den GET-Request mit Execute. Sie erhalten eine Antwort mit Datensätzen aus der Tabelle res.partner.
Berichte
Traffic-Log anzeigen
Navigieren Sie nach Einstellungen > API > Overview > Traffic und zeigen Sie die Listenansicht an. Hier sehen Sie alle Zugriffe auf die REST-API des Odoo Servers. Für Details wählen Sie einen Eintrag an.
Entwicklung
Benutzerdefinierten Endpoint mit Python-Code anlegen
Zeigen Sie Einstellungen > API > Configuration > Endpoints an und wählen Sie Neu. Im folgenden die wichtigsten Parameter zur Erstellung eines Endpoint, welcher die Anfrage-Parameter in einem Python-Skript ausführt:
- Name: Name des Endpoints, beispielsweise Create new product
- Custom Endpoint: Pfad des Enpoints, beispielsweise
product/create - HTTP Method: Wählen Sie passende Methode aus
- Model: Wählen Sie das Datenmodell aus, für welches die Anfrage ausgeführt werden soll
- Evaluation Type: Wählen Sie Execute Python Code
- Code Settings:
result = model.name_create(params.get('name'))
Parameters (Docs):
[{
"name": "name",
"in": "query",
"description": "Product Name",
"schema": {"type": "string"}
}]
Um den benutzerdefinierten Endpoint zu testen, wählen Sie Open Docs und zeigen den Abschnitt mit Pfad /api/v2/custom/product/create an. Führen Sie die Anfrage gemäss API-Pfad testen aus.