Add topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.
Extra information
System documentation: Odoo External API Documentation
Connector Package Documentation
Table of Contents
- 1. Setting up HTTP Client
- 1.1 Steps
- 2. Subscribing to Entities from Odoo through JSON-2 API
- 2.1 Steps
- 2.2 General Concept
- 3. Publishing Entity to Odoo through JSON-2 API
- 3.1 Steps
- 3.2 General Concept
1. Setting up HTTP Client
1.1 Steps
- In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Odoo JSON-2 HTTP Client as the prototype of the HTTP Client.
- Fill in the Base URI, API Key, and Database name (Optional).
2. Subscribing to Entities from Odoo through JSON-2 API
2.1 Steps
- Go to Connections → Incoming and create a new incoming configuration and select Odoo JSON-2 Subscriber as the subscriber.
- Select the Odoo JSON-2 HTTP Client to use.
- Fill in the Model Name field with the model you want to fetch.
- Fill in the Method Name field with the method name you want to call.
- Add any request parameters needed to subscribe to the entity.
- You can optionally add a transformer to transform the request parameters into something you need.
2.2 General Concept
We follow Odoo JSON-2 API documentation on building this connector so you can easily use the connector based on the Odoo External API Documentation.
Model Name
The name of the model you want to subscribe to from Odoo.
Method Name
The name of the method you want to execute in Odoo through the JSON-2 API.
Request Parameters
These are the parameters you can provide to get the needed entity based on the Odoo External API Documentation. Please look at the example below on how to fill the Request Parameters field when subscribing Single Request entity
Input Transformer
Any transformers set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need, either as path parameters and/or as query parameters of an entity.
HTTP Client
It’s the HTTP Client configuration or prototype you will use to access Odoo through JSON-2 API.
3. Publishing Entity to Odoo through JSON-2 API
3.1 Steps
- Go to Connections → Outgoing, create a new outgoing configuration, and select Odoo JSON-2 Publisher as the publisher.
- Select the HTTP Client to use.
- Fill in the Model name that you want the publisher to use.
- Fill in the Method name that you want to use.
- Set up the Payload data or theQuery parameter.
3.2 General Concept
Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration).
Model Name
The name of the model you want to subscribe to from Odoo.
Method Name
The name of the method you want to execute in Odoo through the JSON-2 API.
You can put the payload you want to send to Odoo into the payload property in the data. Here is an example of the Possible Response after Creation.
HTTP Client
It’s the HTTP Client configuration or prototype you will use to access Odoo through JSON-2 API.