| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 1339 |
| Technical Name |
zyra_rest_api_odoo |
| License | OPL-1 |
| Website | https://www.zyra.com |
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 1339 |
| Technical Name |
zyra_rest_api_odoo |
| License | OPL-1 |
| Website | https://www.zyra.com |
Odoo REST API - REST API for Odoo
Build secure REST APIs from Odoo with API keys, authentication endpoints, model-based dynamic CRUD APIs, custom APIs, and built-in rate limiting.
- Create and manage API application keys from Odoo backend.
- Control built-in authentication endpoints from UI (activate/deactivate).
- Create model endpoints with selected fields and related model data.
- Configure custom endpoints for JSON or text responses.
- Apply endpoint-level rate limits and authentication rules.
- Use API key or authenticated session to access protected APIs.
Built-in authentication endpoints (all manageable from Odoo UI):
- POST /api/login: Login with
loginandpassword, returnsuidandsession_id. - POST /api/register: Public user registration with
name,email,password(optionalphone). - POST /api/password/reset: Trigger reset flow using
email. - GET/POST /api/user/details: Get logged-in user profile, groups, model access, and record rules (requires session).
Security controls: failed-attempt window and cooldown support on login/reset endpoints.
Dynamic model endpoint pattern:
/api/model/<model_name>
and
/api/model/<model_name>/<record_id>
- GET: list records with pagination (
limit,offset,order, optionaldomain). - GET by ID: read a single record including configured related data.
- POST: create new record from JSON payload.
- PUT/PATCH: update existing record by ID.
- DELETE: delete record by ID.
You can choose allowed fields per model, set endpoint domain filters, and secure each endpoint using API key/session and rate limits.
- Route format:
/api/custom/<route_key>. - Fast custom responses with JSON or plain text response type.
- Per-endpoint API key/session requirement and per-minute rate limit support.
- Ideal for lightweight integration callbacks, configs, and public metadata endpoints.
Main module overview
Login API in Postman
Register API in Postman
User details API response
Model endpoint example (GET products)
V1.0.0
- Auth API set: login, register, reset password, and user details.
- Dynamic model API endpoint with full CRUD support.
- Custom endpoints with JSON/text responses.
- API key/session authorization and rate limit controls.
Please mail us for support on zyra88.ae@gmail.com
Website: https://www.zyra.com
Odoo Proprietary License v1.0 This software and associated files (the "Software") may only be used (executed, modified, executed after modifications) if you have purchased a valid license from the authors, typically via Odoo Apps, or if you have received a written agreement from the authors of the Software (see the COPYRIGHT file). You may develop Odoo modules that use the Software as a library (typically by depending on it, importing it and using its resources), but without copying any source code or material from the Software. You may distribute those modules under the license of your choice, provided that this license is compatible with the terms of the Odoo Proprietary License (For example: LGPL, MIT, or proprietary licenses similar to this one). It is forbidden to publish, distribute, sublicense, or sell copies of the Software or modified copies of the Software. The above copyright notice and this permission notice must be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Please log in to comment on this module