[IMP] content/developer/webservices
It is hard to find and learn about RPC in Odoo, users hardly know about JSON-RPC as the only place where we talk about it in deep down in the *How to make a Module* tutorial. In the commit, we isolated the tutorial about RPC in a dedicated file, that file is better referenced thanks to cross-references in some others places that are talking about RPC Task: 2884559 Part-of: odoo/documentation#2481
This commit is contained in:
Julien Castiaux
parent
ff807ecbc3
commit
83c2e6de0b
@ -7,6 +7,9 @@ all of its data are also available from the outside for external analysis or
|
|||||||
integration with various tools. Part of the :ref:`reference/orm/model` API is
|
integration with various tools. Part of the :ref:`reference/orm/model` API is
|
||||||
easily available over XML-RPC_ and accessible from a variety of languages.
|
easily available over XML-RPC_ and accessible from a variety of languages.
|
||||||
|
|
||||||
|
.. seealso::
|
||||||
|
- :doc:`Tutorial on web services <../howtos/web_services>`
|
||||||
|
|
||||||
Connection
|
Connection
|
||||||
==========
|
==========
|
||||||
|
|
||||||
|
|||||||
@ -11,6 +11,7 @@ Tutorials
|
|||||||
howtos/themes
|
howtos/themes
|
||||||
howtos/website
|
howtos/website
|
||||||
howtos/backend
|
howtos/backend
|
||||||
|
howtos/web_services
|
||||||
howtos/profilecode
|
howtos/profilecode
|
||||||
howtos/company
|
howtos/company
|
||||||
howtos/accounting_localization
|
howtos/accounting_localization
|
||||||
|
|||||||
@ -1369,151 +1369,6 @@ Dashboards
|
|||||||
and automatically displayed in the web client when the OpenAcademy main
|
and automatically displayed in the web client when the OpenAcademy main
|
||||||
menu is selected.
|
menu is selected.
|
||||||
|
|
||||||
WebServices
|
|
||||||
===========
|
|
||||||
|
|
||||||
The web-service module offer a common interface for all web-services :
|
|
||||||
|
|
||||||
- XML-RPC
|
|
||||||
- JSON-RPC
|
|
||||||
|
|
||||||
Business objects can also be accessed via the distributed object
|
|
||||||
mechanism. They can all be modified via the client interface with contextual
|
|
||||||
views.
|
|
||||||
|
|
||||||
Odoo is accessible through XML-RPC/JSON-RPC interfaces, for which libraries
|
|
||||||
exist in many languages.
|
|
||||||
|
|
||||||
XML-RPC Library
|
|
||||||
---------------
|
|
||||||
|
|
||||||
The following example is a Python 3 program that interacts with an Odoo
|
|
||||||
server with the library ``xmlrpc.client``::
|
|
||||||
|
|
||||||
import xmlrpc.client
|
|
||||||
|
|
||||||
root = 'http://%s:%d/xmlrpc/' % (HOST, PORT)
|
|
||||||
|
|
||||||
uid = xmlrpc.client.ServerProxy(root + 'common').login(DB, USER, PASS)
|
|
||||||
print("Logged in as %s (uid: %d)" % (USER, uid))
|
|
||||||
|
|
||||||
# Create a new note
|
|
||||||
sock = xmlrpc.client.ServerProxy(root + 'object')
|
|
||||||
args = {
|
|
||||||
'color' : 8,
|
|
||||||
'memo' : 'This is a note',
|
|
||||||
'create_uid': uid,
|
|
||||||
}
|
|
||||||
note_id = sock.execute(DB, uid, PASS, 'note.note', 'create', args)
|
|
||||||
|
|
||||||
.. exercise:: Add a new service to the client
|
|
||||||
|
|
||||||
Write a Python program able to send XML-RPC requests to a PC running
|
|
||||||
Odoo (yours, or your instructor's). This program should display all
|
|
||||||
the sessions, and their corresponding number of seats. It should also
|
|
||||||
create a new session for one of the courses.
|
|
||||||
|
|
||||||
.. only:: solutions
|
|
||||||
|
|
||||||
.. code-block:: python
|
|
||||||
|
|
||||||
import functools
|
|
||||||
import xmlrpc.client
|
|
||||||
HOST = 'localhost'
|
|
||||||
PORT = 8069
|
|
||||||
DB = 'openacademy'
|
|
||||||
USER = 'admin'
|
|
||||||
PASS = 'admin'
|
|
||||||
ROOT = 'http://%s:%d/xmlrpc/' % (HOST,PORT)
|
|
||||||
|
|
||||||
# 1. Login
|
|
||||||
uid = xmlrpc.client.ServerProxy(ROOT + 'common').login(DB,USER,PASS)
|
|
||||||
print("Logged in as %s (uid:%d)" % (USER,uid))
|
|
||||||
|
|
||||||
call = functools.partial(
|
|
||||||
xmlrpc.client.ServerProxy(ROOT + 'object').execute,
|
|
||||||
DB, uid, PASS)
|
|
||||||
|
|
||||||
# 2. Read the sessions
|
|
||||||
sessions = call('openacademy.session','search_read', [], ['name','seats'])
|
|
||||||
for session in sessions:
|
|
||||||
print("Session %s (%s seats)" % (session['name'], session['seats']))
|
|
||||||
# 3.create a new session
|
|
||||||
session_id = call('openacademy.session', 'create', {
|
|
||||||
'name' : 'My session',
|
|
||||||
'course_id' : 2,
|
|
||||||
})
|
|
||||||
|
|
||||||
Instead of using a hard-coded course id, the code can look up a course
|
|
||||||
by name::
|
|
||||||
|
|
||||||
# 3.create a new session for the "Functional" course
|
|
||||||
course_id = call('openacademy.course', 'search', [('name','ilike','Functional')])[0]
|
|
||||||
session_id = call('openacademy.session', 'create', {
|
|
||||||
'name' : 'My session',
|
|
||||||
'course_id' : course_id,
|
|
||||||
})
|
|
||||||
|
|
||||||
JSON-RPC Library
|
|
||||||
----------------
|
|
||||||
|
|
||||||
The following example is a Python 3 program that interacts with an Odoo server
|
|
||||||
with the standard Python libraries ``urllib.request`` and ``json``. This
|
|
||||||
example assumes the **Productivity** app (``note``) is installed::
|
|
||||||
|
|
||||||
import json
|
|
||||||
import random
|
|
||||||
import urllib.request
|
|
||||||
|
|
||||||
HOST = 'localhost'
|
|
||||||
PORT = 8069
|
|
||||||
DB = 'openacademy'
|
|
||||||
USER = 'admin'
|
|
||||||
PASS = 'admin'
|
|
||||||
|
|
||||||
def json_rpc(url, method, params):
|
|
||||||
data = {
|
|
||||||
"jsonrpc": "2.0",
|
|
||||||
"method": method,
|
|
||||||
"params": params,
|
|
||||||
"id": random.randint(0, 1000000000),
|
|
||||||
}
|
|
||||||
req = urllib.request.Request(url=url, data=json.dumps(data).encode(), headers={
|
|
||||||
"Content-Type":"application/json",
|
|
||||||
})
|
|
||||||
reply = json.loads(urllib.request.urlopen(req).read().decode('UTF-8'))
|
|
||||||
if reply.get("error"):
|
|
||||||
raise Exception(reply["error"])
|
|
||||||
return reply["result"]
|
|
||||||
|
|
||||||
def call(url, service, method, *args):
|
|
||||||
return json_rpc(url, "call", {"service": service, "method": method, "args": args})
|
|
||||||
|
|
||||||
# log in the given database
|
|
||||||
url = "http://%s:%s/jsonrpc" % (HOST, PORT)
|
|
||||||
uid = call(url, "common", "login", DB, USER, PASS)
|
|
||||||
|
|
||||||
# create a new note
|
|
||||||
args = {
|
|
||||||
'color': 8,
|
|
||||||
'memo': 'This is another note',
|
|
||||||
'create_uid': uid,
|
|
||||||
}
|
|
||||||
note_id = call(url, "object", "execute", DB, uid, PASS, 'note.note', 'create', args)
|
|
||||||
|
|
||||||
Examples can be easily adapted from XML-RPC to JSON-RPC.
|
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
There are a number of high-level APIs in various languages to access Odoo
|
|
||||||
systems without *explicitly* going through XML-RPC or JSON-RPC, such as:
|
|
||||||
|
|
||||||
* https://github.com/akretion/ooor
|
|
||||||
* https://github.com/OCA/odoorpc
|
|
||||||
* https://github.com/nicolas-van/openerp-client-lib
|
|
||||||
* http://pythonhosted.org/OdooRPC
|
|
||||||
* https://github.com/abhishek-jaiswal/php-openerp-lib
|
|
||||||
|
|
||||||
.. [#autofields] it is possible to :ref:`disable the automatic creation of some
|
.. [#autofields] it is possible to :ref:`disable the automatic creation of some
|
||||||
fields <reference/fields/automatic/log_access>`
|
fields <reference/fields/automatic/log_access>`
|
||||||
.. [#rawsql] writing raw SQL queries is possible, but requires care as it
|
.. [#rawsql] writing raw SQL queries is possible, but requires care as it
|
||||||
|
|||||||
148
content/developer/howtos/web_services.rst
Normal file
148
content/developer/howtos/web_services.rst
Normal file
@ -0,0 +1,148 @@
|
|||||||
|
============
|
||||||
|
Web Services
|
||||||
|
============
|
||||||
|
|
||||||
|
The web-service module offer a common interface for all web-services :
|
||||||
|
|
||||||
|
- XML-RPC
|
||||||
|
- JSON-RPC
|
||||||
|
|
||||||
|
Business objects can also be accessed via the distributed object
|
||||||
|
mechanism. They can all be modified via the client interface with contextual
|
||||||
|
views.
|
||||||
|
|
||||||
|
Odoo is accessible through XML-RPC/JSON-RPC interfaces, for which libraries
|
||||||
|
exist in many languages.
|
||||||
|
|
||||||
|
XML-RPC Library
|
||||||
|
---------------
|
||||||
|
|
||||||
|
The following example is a Python 3 program that interacts with an Odoo
|
||||||
|
server with the library ``xmlrpc.client``::
|
||||||
|
|
||||||
|
import xmlrpc.client
|
||||||
|
|
||||||
|
root = 'http://%s:%d/xmlrpc/' % (HOST, PORT)
|
||||||
|
|
||||||
|
uid = xmlrpc.client.ServerProxy(root + 'common').login(DB, USER, PASS)
|
||||||
|
print("Logged in as %s (uid: %d)" % (USER, uid))
|
||||||
|
|
||||||
|
# Create a new note
|
||||||
|
sock = xmlrpc.client.ServerProxy(root + 'object')
|
||||||
|
args = {
|
||||||
|
'color' : 8,
|
||||||
|
'memo' : 'This is a note',
|
||||||
|
'create_uid': uid,
|
||||||
|
}
|
||||||
|
note_id = sock.execute(DB, uid, PASS, 'note.note', 'create', args)
|
||||||
|
|
||||||
|
.. exercise:: Add a new service to the client
|
||||||
|
|
||||||
|
Write a Python program able to send XML-RPC requests to a PC running
|
||||||
|
Odoo (yours, or your instructor's). This program should display all
|
||||||
|
the sessions, and their corresponding number of seats. It should also
|
||||||
|
create a new session for one of the courses.
|
||||||
|
|
||||||
|
.. only:: solutions
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
import functools
|
||||||
|
import xmlrpc.client
|
||||||
|
HOST = 'localhost'
|
||||||
|
PORT = 8069
|
||||||
|
DB = 'openacademy'
|
||||||
|
USER = 'admin'
|
||||||
|
PASS = 'admin'
|
||||||
|
ROOT = 'http://%s:%d/xmlrpc/' % (HOST,PORT)
|
||||||
|
|
||||||
|
# 1. Login
|
||||||
|
uid = xmlrpc.client.ServerProxy(ROOT + 'common').login(DB,USER,PASS)
|
||||||
|
print("Logged in as %s (uid:%d)" % (USER,uid))
|
||||||
|
|
||||||
|
call = functools.partial(
|
||||||
|
xmlrpc.client.ServerProxy(ROOT + 'object').execute,
|
||||||
|
DB, uid, PASS)
|
||||||
|
|
||||||
|
# 2. Read the sessions
|
||||||
|
sessions = call('openacademy.session','search_read', [], ['name','seats'])
|
||||||
|
for session in sessions:
|
||||||
|
print("Session %s (%s seats)" % (session['name'], session['seats']))
|
||||||
|
# 3.create a new session
|
||||||
|
session_id = call('openacademy.session', 'create', {
|
||||||
|
'name' : 'My session',
|
||||||
|
'course_id' : 2,
|
||||||
|
})
|
||||||
|
|
||||||
|
Instead of using a hard-coded course id, the code can look up a course
|
||||||
|
by name::
|
||||||
|
|
||||||
|
# 3.create a new session for the "Functional" course
|
||||||
|
course_id = call('openacademy.course', 'search', [('name','ilike','Functional')])[0]
|
||||||
|
session_id = call('openacademy.session', 'create', {
|
||||||
|
'name' : 'My session',
|
||||||
|
'course_id' : course_id,
|
||||||
|
})
|
||||||
|
|
||||||
|
.. seealso::
|
||||||
|
- :doc:`../api/external_api`: The in-depth tutorial on XML-RPC with examples spanning multiple programming languages.
|
||||||
|
|
||||||
|
JSON-RPC Library
|
||||||
|
----------------
|
||||||
|
|
||||||
|
The following example is a Python 3 program that interacts with an Odoo server
|
||||||
|
with the standard Python libraries ``urllib.request`` and ``json``. This
|
||||||
|
example assumes the **Productivity** app (``note``) is installed::
|
||||||
|
|
||||||
|
import json
|
||||||
|
import random
|
||||||
|
import urllib.request
|
||||||
|
|
||||||
|
HOST = 'localhost'
|
||||||
|
PORT = 8069
|
||||||
|
DB = 'openacademy'
|
||||||
|
USER = 'admin'
|
||||||
|
PASS = 'admin'
|
||||||
|
|
||||||
|
def json_rpc(url, method, params):
|
||||||
|
data = {
|
||||||
|
"jsonrpc": "2.0",
|
||||||
|
"method": method,
|
||||||
|
"params": params,
|
||||||
|
"id": random.randint(0, 1000000000),
|
||||||
|
}
|
||||||
|
req = urllib.request.Request(url=url, data=json.dumps(data).encode(), headers={
|
||||||
|
"Content-Type":"application/json",
|
||||||
|
})
|
||||||
|
reply = json.loads(urllib.request.urlopen(req).read().decode('UTF-8'))
|
||||||
|
if reply.get("error"):
|
||||||
|
raise Exception(reply["error"])
|
||||||
|
return reply["result"]
|
||||||
|
|
||||||
|
def call(url, service, method, *args):
|
||||||
|
return json_rpc(url, "call", {"service": service, "method": method, "args": args})
|
||||||
|
|
||||||
|
# log in the given database
|
||||||
|
url = "http://%s:%s/jsonrpc" % (HOST, PORT)
|
||||||
|
uid = call(url, "common", "login", DB, USER, PASS)
|
||||||
|
|
||||||
|
# create a new note
|
||||||
|
args = {
|
||||||
|
'color': 8,
|
||||||
|
'memo': 'This is another note',
|
||||||
|
'create_uid': uid,
|
||||||
|
}
|
||||||
|
note_id = call(url, "object", "execute", DB, uid, PASS, 'note.note', 'create', args)
|
||||||
|
|
||||||
|
Examples can be easily adapted from XML-RPC to JSON-RPC.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
There are a number of high-level APIs in various languages to access Odoo
|
||||||
|
systems without *explicitly* going through XML-RPC or JSON-RPC, such as:
|
||||||
|
|
||||||
|
* https://github.com/akretion/ooor
|
||||||
|
* https://github.com/OCA/odoorpc
|
||||||
|
* https://github.com/nicolas-van/openerp-client-lib
|
||||||
|
* http://pythonhosted.org/OdooRPC
|
||||||
|
* https://github.com/abhishek-jaiswal/php-openerp-lib
|
||||||
Loading…
Reference in New Issue
Block a user