⚠️ Looking forodoo 14module?Meet jwt_provider2 which is a completely rework, only for Odoo 14 (and above, maybe).
This module is meant for developers, building endpoints for web and mobile app.
Currently supports odoo 11.0 12.0 and 13.0.
Attention: There is a break change in 13.0, see the Installation section.
This module require pyjwt and simplejson to be installed. Run:
pip3 install pyjwt
pip3 install simplejsonIf you run odoo in docker, remember to login to bash in docker container and run the above command.
Download or clone this repo and move it to odoo addons dir. Install it via odoo just like a normal module.
Version 13: now will get secret key from os ENV, using os.environ.get('ODOO_JWT_KEY').
-
If you're running odoo locally (or inside a docker container), run
EXPORT ODOO_JWT_KEY="your_key". -
If using docker compose, add
ODOO_JWT_KEY=your_keyinenvironmentsection of yml file.
Developers might need to verify jwt token inside private endpoints:
http_method, body, headers, token = jwt_http.parse_request()
result = validator.verify_token(token)
if not result['status']:
return jwt_http.errcode(code=result['code'], message=result['message'])- Add an interface to store secret key (instead of hard-coding the key) and ability to pick a hashing algorithm (currently we use HMACSHA256).
For private endpoints, include your jwt token in the header like this:
Authorization: Bearer your_token
- Login
POST /api/login
Request payload:
[email protected]&
password=password
Response:
400: Incorect login
200: OK
{
"data": {
"user": {
"id": 8,
"login": "[email protected]",
"company_id": [
1,
"My Company"
],
"name": "John"
},
"token": "generated_token"
},
"success": true,
"message": null
}- Register
POST api/register
Require: Free signup setting is ON (as well as enabled auth_signup).
On success, response an access token as well.
Request payload:
[email protected]&
password=password&
name=Your%sName
Response:
400: User input invalid, message might be one of:
Invalid email address
Name cannot be empty
Password cannot be empty
Email address already existed
501: Signup is disabled
200: OK
{
"data": {
"user": {
"id": 8,
"login": "[email protected]",
"company_id": [
1,
"My Company"
],
"name": "John"
},
"token": "generated_token"
},
"success": true,
"message": null
}- My profile
ANY /api/me
Response:
498: Token invalid or expired
200: OK, return user object
{
"data": null,
"success": {
"company_id": [
1,
"My Company"
],
"avatar": "http://yourwebsite.com/web/avatar/8",
"name": "Join",
"id": 8,
"email": "[email protected]"
},
"message": null
}- Logout
ANY /api/logout
Response:
498: Token invalid or expired
200: OK, log the user out
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent