Skip to Content
This question has been flagged
documentationapijsonrpcExternalAPI
6 Replies
14387 Views
Avatar
Allan

I have a big pet peeve with Odoo documentation. I have previously worked with XML-RPC but is now switching to JSON-RPC. But I have always struggled to find good documentation. Only a few simple examples are to be found online - and often in some SDK of a certain language - not language-agnostic so that anyone can figure it out for their language. So I have a couple of core questions:


1. Why are there absolutely no instructions on how to find out which methods, fields and values are available in a JSON-RPC call? At the very minimum it could be stated that one can inspect the network requests in the browser to see examples...!


2. Why is there no explanation of the difference between the JSON-RPC API calls used in the browser and the JSON-RPC API meant for external use? This could help translating the browser requests into normal JSON-RPC requests.


This makes it very difficult (= very time consuming => waste of money) for people unfamiliar with Odoo to make integrations to it. A very undesirable effect.

Avatar
Discard
Avatar
Sébastien Feugère
Best Answer

NOTE: would have like to use the "commenting tool", but I don't have enough XP for that, so here is a non-answer :)

All the external ressources (tutorial, YouTube videos) are useful.

This is not enough, though: why the APIs does not have a clear auto-generated documentation? It makes it's usage overcomplicated. Also, the lack of examples makes things incredibly experimental. 

I had to rely on alternative documentation content from GitHub (created by the community, see link) to understand things. I think it could be reviewed by the Odoo team and merged to the existing doc. That would be very helpful for newcomers.

  • https://github.com/amlaksil/Odoo-JSON-RPC-API/

It's also confusing and not clear why the "External API" and "Web Services" docs are separated.

  • https://www.odoo.com/documentation/17.0/developer/reference/external_api.html#
  • https://www.odoo.com/documentation/master/developer/howtos/web_services.html


Avatar
Discard
Avatar
Martin Krafft
Best Answer

(tried to use the "commenting tool", but that doesn't seem to work, so here is a non-answer:)

I can relate. We're migrating to Odoo DMS from Paperless, and this means I have to script the transfer of a couple tens of thousand documents, while preserving the metadata, such as tags, correspondents, notes, etc..

I've looked around but I cannot find a proper API description, nor any actual examples. It seems the external API is a simple wrapper around the models, but how do I get a list of models, and of the fields, and yes, it would really be useful to have an example of e.g. creating a DMS record with some tags and notes using the API.

Avatar
Discard
Avatar
Niyas Raphy (Walnut IT)
Best Answer

Hi,
See this tutorial about json rpc in odoo:  Odoo JSON RPC

Thanks

Avatar
Discard
Avatar
Sébastien Denis
Best Answer

Did you find any valuable documentation ? Looking for the same stuff without success

Avatar
Discard
Avatar
Allan
Author Best Answer

You call that documentation?? It doesn't answer my questions at all! The articles are basically useless - extremely simple and a lot of info which is already obvious to a programmer!

Avatar
Discard
Allan
Author

Why can't I comment on Cybrosys' answer?!!

Allan
Author

I can't even delete my own answer and comments. What amateur system is this??

Avatar
Cybrosys Techno Solutions Pvt.Ltd
Best Answer

Hi,
Refer to the following documentation
https://www.cybrosys.com/blog/how-to-configure-the-json-rpc-api-in-odoo-15

https://www.cybrosys.com/blog/how-to-configure-json-rpc-and-xml-rpc-using-postman-for-sending-api-requests


Hope it helps

Avatar
Discard
Related Posts Replies Views Activity
Odoo JSON-RPC API
api jsonrpc
Avatar
0
Feb 25
1014
Endpoint for external API
api ExternalAPI
Avatar
Avatar
1
May 24
3146
What is the syntax for Update in JSON External API?
jsonrpc ExternalAPI
Avatar
1
Nov 22
4509
What is the API endpoint for JSON-RPC?
api jsonrpc
Avatar
0
Oct 20
4363
jsonrpc bulk write
api odoo jsonrpc
Avatar
Avatar
1
Apr 25
472