Skip to Content

REST API

by
Odoo
v 10.0 v 11.0 Third Party 1775
Download for v 11.0 Deploy on Odoo.sh
Availability
Odoo Online
Odoo.sh
On Premise
Technical Name smile_api_rest
LicenseAGPL-3
Websitehttp://www.smile.fr
Versions 10.0 11.0 14.0 15.0
You bought this module and need support? Click here!

Smile-SA/odoo_addons

API Rest

This module provisions you with an API which allows you to access models through HTTP requests.

Table of contents

Requirements

There are no requirements to use this module.

Usage

Available URIs

URI Method Description
/api/auth POST Login in Odoo and set cookies
/api/<model> GET Read all (with optional domain, fields, offset, limit, order)
/api/<model>/<id> GET Read one (with optional fields)
/api/<model> POST Create a record
/api/<model>/<id> PUT Update a record
/api/<model>/<id> DELETE Delete a record
/api/<model>/<id>/<method> PUT Call method (with optional parameters)

WARNING: before calling /api/auth, call /web?db=*** otherwise web service is not found.

Error responses

Error response Description
{"error": "u'<model>'"} <model> does not exist or has a typo.
{"error": "<error_message>"} the python error message raised

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback here.

Do not contact contributors directly about support or help with technical issues.

Credits

Contributors

  • Corentin POUHET-BRUNERIE

Maintainer

This module is maintained by Smile SA.

Since 1991 Smile has been a pioneer of technology and also the European expert in open source solutions.

Please log in to comment on this module

  • The author can leave a single reply to each comment.
  • This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
  • If you want to start a discussion with the author, please use the developer contact information. They can usually be found in the description.
Please choose a rating from 1 to 5 for this module.
WARNING: before calling /api/auth, call /web?db=*** otherwise web service is not found.
by
Taha
on 3/22/19, 7:28 AM

Why do we need to do this? How to handle it at the android app end? Thanks

if you module doesn't work
by
PengXu
on 3/10/19, 10:26 PM

may be you should add the module name to server_wide_module in your odoorc

hiii
by
sachin.r@apextechnomatics.in
on 2/5/21, 12:43 AM
1. How to Passing Parameter in /api/auth & all api ??
2.can i use API in Android App & Can this api support string values ???
/api/auth
/api/<model>
/api/<model>/<id>
/api/<model>
/api/<model>/<id>
/api/<model>/<id>
/api/<model>/<id>/<method>
 

{
"type": "access_token_not_found",
"message": "missing access token in request header"
}
How do we use fields variable in the get request
by
Taha
on 3/22/19, 3:09 AM

Hi, I added csrf=False in auth POST request and now it is working. however, I would like to know how do we pass fields variable in the GET request. Thanks.

How to get CSRF token
by
Taha
on 3/21/19, 6:41 AM

Hi, The module works great. But, how do we get the csrf token. It keeps giving the error {"error": "'auth'"} Thanks.

Download for 11.0 broken link
by
David Welch
on 6/22/18, 11:38 AM

11.0 version link doesn't work