Connect to CloudOffix
The XML-RPC API on your CloudOffix address.
CloudOffix, the front office of Prospera ERP Suite, offers an XML-RPC API on your own CloudOffix address. It works with the same records your team sees: contacts, companies, opportunities, quotations and tickets, within the permissions of the user you connect with.
Create an integration user
Ask your administrator for a dedicated CloudOffix user for the integration, with only the access it needs.
Check the server
A call that needs no login:
POST https:///xmlrpc/2/common method: version Sign in
Call authenticate on /xmlrpc/2/common with your database name, the user’s login and password. It returns the user id you use for every later call. Ask us for your database name.
Read and write
Call execute_kw on /xmlrpc/2/object with the database, user id, password, the record type, the method (search_read, create, write) and its arguments.
import xmlrpc.client url = "https://" common = xmlrpc.client.ServerProxy(url + "/xmlrpc/2/common") uid = common.authenticate(" ", " ", " ", {}) obj = xmlrpc.client.ServerProxy(url + "/xmlrpc/2/object") leads = obj.execute_kw(" ", uid, " ", "crm.lead", "search_read", [[["type", "=", "opportunity"]]], {"fields": ["name", "partner_id", "expected_revenue"], "limit": 20})
Good to know
- Keep the password of the integration user in your secret store, and change it if it may have been seen.
- Record types use technical names, for example crm.lead for leads and opportunities and res.partner for contacts and companies. We give you the list for your setup.