REST API/OpenAPI/Swagger
by IT-Projects LLC https://t.me/sync_studio , Ivan Yelizariev https://t.me/sync_studioAvailability |
Odoo Online
Odoo.sh
On Premise
|
Technical Name |
openapi |
License | LGPL-3 |
Website | https://t.me/sync_studio |
Versions | 16.0 15.0 14.0 11.0 8.0 13.0 10.0 12.0 |
REST API/OpenAPI/Swagger
Secure tool for convenient integrations
Version: v10.0.1.1.9
Tested and maintained by
IT Projects Labs
Assitance: help@itpp.dev
- Grant exact access rights needed for an integration
- Load generated OpenAPI Specification into Postman, Swagger Editor or any other tools that supports it
- Monitor API requests/responses at desired level of details
Easy to use in any programming languages
# https://github.com/Yelp/bravado from bravado.requests_client import RequestsClient from bravado.client import SwaggerClient http_client = RequestsClient() http_client.set_basic_auth('yourdomain.example.com', 'DATABASE-NAME', 'USER-TOKEN') odoo = SwaggerClient.from_url( 'https://yourdomain.example.com/api/v1/demo/swagger.json?token=demo_token&db=source', http_client=http_client ) result = odoo.res_partner.callMethodForResPartnerModel( method_name="search", body={ 'args': [[('email', '=', 'sync@it-projects.info')]] } ).response().incoming_response.json() partner_id = result and result[0] if not partner_id: result = odoo.res_partner.addResPartner(body={ "name": "OpenAPI Support", "email": "sync@it-projects.info" }).response().result partner_id = result.id odoo.res_partner.callMethodForResPartnerSingleRecord( id=partner_id, method_name="message_post", body={ "kwargs": { "body": "The Openapi module works in Python! Thank you!", "partner_ids": [partner_id] } } ).response()
Comming soon...
Comming soon...
Comming soon...
Comming soon...
Comming soon...
You may send this page to your IT guys to evaluate the possibilities or just tell us your concerns: help@itpp.dev
Let our expertise work for you!
(Doors and windows below are clickable)
/itpp-labs-1100.jpg)
/itpp-labs-930.jpg)
/itpp-labs-690.jpg)
REST API/Openapi/Swagger
Installation
Install this module in a usual way
Add openapi to --load parameter, e.g.:
./odoo-bin --workers=2 --load openapi,web --config=/path/to/odoo.conf
Configuration
Activating and customization
Open menu [[ OpenAPI ]] >> OpenAPI >> Integrations
Click [Create]
Specify Name for integration, e.g. test
Set Log requests to Full
Set Log responses to Full
In Accessable models tab click Add an item
Set Model, for example res.users
Configure allowed operations
[x] Create via API
- Set Creation Context Presets, for example
- Name: brussels
- Context: {'default_tz':'Europe/Brussels', 'default_lang':'fr_BE'}
- Set Creation Context Presets, for example
[x] Read via API
Set Read One Fields -- fields to return on reading one record
Set Read Many Fields -- fields to return on reading multiple records
Note: you can use Export widget in corresponding Model to create Fields list. To do that:
- Open menu for the Model
- Switch to list view
- Select any record
- click [Action] -> Export
- Set Export Type to Export all Data
- Add the fields you need to right column
- Click Save fields list, choose name and save the list
- Now the list is availab to set Read One Fields, Read Many Fields settings
[x] Update via API
[x] Delete via API
Click [Save]
Copy Specification Link to use it in any system that support OpenAPI
Authentication
- Activate Developer Mode
- Open menu [[ Settings ]] >> Users >> Users
- Select a user that will be used for iteracting over API
- In Allowed Integration select some integrations
- Copy OpenAPI Token to use it in any system that support OpenAPI
Usage
As the simplest example, you can try API in Swagger Editor. It allows to review and check API
- Open http://editor.swagger.io/
- Click menu File >> Import File
- Set Specification link
- RESULT: Specification is parsed succefully and you can see API presentation
- Click [Authorize] button
- Username -- set database name
- Password -- set OpenAPI Token
For more examples visit https://itpp.dev/sync website
Please log in to comment on this module