External API

OpenSPP is usually extended internally via modules, but many of its features and all of its data are also available from the outside for external analysis or integration with various tools. Part of the Models API is easily available over XML-RPC and accessible from a variety of languages.

See also

Look at exemples from the Odoo documentation: Web Services

Connection

Configuration

If you already have an OpenSPP server installed, you can just use its parameters.

Important

While you can use your password to connect to the API, it is recommended to instead use an API Keys as they can be revoked easily.

PythonRubyPHPJava

url = <insert server URL>
db = <insert database name>
username = 'admin'
password = <insert password for your admin user (default: admin)>

API Keys

OpenSPP has support for api keys and (depending on modules or settings) may require these keys to perform webservice operations.

The way to use API Keys in your scripts is to simply replace your password by the key. The login remains in-use. You should store the API Key as carefully as the password as they essentially provide the same access to your user account (although they can not be used to log-in via the interface).

Important

As API keys give the same access as your password, it is recommended to create a dedicated user for the API, and to only give it the rights it needs to perform its tasks.

In order to add a key to your account, simply go to your Preferences (or My Profile):

then open the Account Security tab, and click New API Key:

Input a description for the key, this description should be as clear and complete as possible: it is the only way you will have to identify your keys later and know whether you should remove them or keep them around.

Click Generate Key, then copy the key provided. Store this key carefully: it is equivalent to your password, and just like your password the system will not be able to retrieve or show the key again later on. If you lose this key, you will have to create a new one (and probably delete the one you lost).

Once you have keys configured on your account, they will appear above the New API Key button, and you will be able to delete them:

A deleted API key can not be undeleted or re-set. You will have to generate a new key and update all the places where you used the old one.

Test database

To make exploration simpler, you can also ask https://demo.openspp.org for a test database:

PythonRubyPHPJava

import xmlrpc.client
info = xmlrpc.client.ServerProxy('https://demo.openspp.org/start').start()
url, db, username, password = info['host'], info['database'], info['user'], info['password']

Logging in

OpenSPP requires users of the API to be authenticated before they can query most data.

The xmlrpc/2/common endpoint provides meta-calls which don't require authentication, such as the authentication itself or fetching version information. To verify if the connection information is correct before trying to authenticate, the simplest call is to ask for the server's version. The authentication itself is done through the authenticate function and returns a user identifier (uid) used in authenticated calls instead of the login.

PythonRubyPHPJava

common = xmlrpc.client.ServerProxy('{}/xmlrpc/2/common'.format(url))
common.version()

Result:

{
    "server_version": "17.0",
    "server_version_info": [17, 0, 0, "final", 0],
    "server_serie": "17.0",
    "protocol_version": 1,
}

PythonRubyPHPJava

uid = common.authenticate(db, username, password, {})

Calling methods

The second endpoint is xmlrpc/2/object. It is used to call methods of OpenSPP models via the execute_kw RPC function.

Each call to execute_kw takes the following parameters:

• the database to use, a string

• the user id (retrieved through authenticate), an integer

• the user's api key, a string

• the model name, a string

• the method name, a string

• an array/list of parameters passed by position

• a mapping/dict of parameters to pass by keyword (optional)

Note

For instance, to see if we can read the res.partner model, we can call check_access_rights with operation passed by position and raise_exception passed by keyword (in order to get a true/false result rather than true/error):

PythonRubyPHPJava

models = xmlrpc.client.ServerProxy('{}/xmlrpc/2/object'.format(url))
models.execute_kw(db, uid, password, 'res.partner', 'check_access_rights', ['read'], {'raise_exception': False})

Result:

true

List records

Records can be listed and filtered via search().

search() takes a mandatory domain filter (possibly empty), and returns the database identifiers of all records matching the filter.

Note

To list customer companies, for instance:

PythonRubyPHPJava

models.execute_kw(db, uid, password, 'res.partner', 'search', [[['is_company', '=', True]]])

Result:

[7, 18, 12, 14, 17, 19, 8, 31, 26, 16, 13, 20, 30, 22, 29, 15, 23, 28, 74]

Pagination

By default a search will return the ids of all records matching the condition, which may be a huge number. offset and limit parameters are available to only retrieve a subset of all matched records.

Note

PythonRubyPHPJava

models.execute_kw(db, uid, password, 'res.partner', 'search', [[['is_company', '=', True]]], {'offset': 10, 'limit': 5})

Result:

[13, 20, 30, 22, 29]

Count records

Rather than retrieve a possibly gigantic list of records and count them, search_count() can be used to retrieve only the number of records matching the query. It takes the same domain filter as search() and no other parameter.

Note

PythonRubyPHPJava

models.execute_kw(db, uid, password, 'res.partner', 'search_count', [[['is_company', '=', True]]])

Result:

19

Note

Calling search then search_count (or the other way around) may not yield coherent results if other users are using the server: stored data could have changed between the calls.

Read records

Record data are accessible via the read() method, which takes a list of ids (as returned by search()), and optionally a list of fields to fetch. By default, it fetches all the fields the current user can read, which tends to be a huge amount.

Note

PythonRubyPHPJava

ids = models.execute_kw(db, uid, password, 'res.partner', 'search', [[['is_company', '=', True]]], {'limit': 1})
[record] = models.execute_kw(db, uid, password, 'res.partner', 'read', [ids])
# count the number of fields fetched by default
len(record)

Result:

121

Conversely, picking only three fields deemed interesting.

PythonRubyPHPJava

models.execute_kw(db, uid, password, 'res.partner', 'read', [ids], {'fields': ['name', 'country_id', 'comment']})

Result:

[{"comment": false, "country_id": [21, "Belgium"], "id": 7, "name": "Agrolait"}]

Note

Even if the id field is not requested, it is always returned.

List record fields

fields_get() can be used to inspect a model's fields and check which ones seem to be of interest.

Because it returns a large amount of meta-information (it is also used by client programs) it should be filtered before printing, the most interesting items for a human user are string (the field's label), help (a help text if available) and type (to know which values to expect, or to send when updating a record).

Note

PythonRubyPHPJava

models.execute_kw(db, uid, password, 'res.partner', 'fields_get', [], {'attributes': ['string', 'help', 'type']})

Result:

{
    "ean13": {
        "type": "char",
        "help": "BarCode",
        "string": "EAN13"
    },
    "property_account_position_id": {
        "type": "many2one",
        "help": "The fiscal position will determine taxes and accounts used for the partner.",
        "string": "Fiscal Position"
    },
    "signup_valid": {
        "type": "boolean",
        "help": "",
        "string": "Signup Token is Valid"
    },
    "date_localization": {
        "type": "date",
        "help": "",
        "string": "Geo Localization Date"
    },
    "ref_company_ids": {
        "type": "one2many",
        "help": "",
        "string": "Companies that refers to partner"
    },
    "sale_order_count": {
        "type": "integer",
        "help": "",
        "string": "# of Sales Order"
    },
    "purchase_order_count": {
        "type": "integer",
        "help": "",
        "string": "# of Purchase Order"
    },

Search and read

Because it is a very common task, OpenSPP provides a search_read() shortcut which, as its name suggests, is equivalent to a search() followed by a read(), but avoids having to perform two requests and keep ids around.

Its arguments are similar to search()'s, but it can also take a list of fields (like read(), if that list is not provided it will fetch all fields of matched records).

Note

PythonRubyPHPJava

models.execute_kw(db, uid, password, 'res.partner', 'search_read', [[['is_company', '=', True]]], {'fields': ['name', 'country_id', 'comment'], 'limit': 5})

Result:

[
    {
        "comment": false,
        "country_id": [ 21, "Belgium" ],
        "id": 7,
        "name": "Agrolait"
    },
    {
        "comment": false,
        "country_id": [ 76, "France" ],
        "id": 18,
        "name": "Axelor"
    },
    {
        "comment": false,
        "country_id": [ 233, "United Kingdom" ],
        "id": 12,
        "name": "Bank Wealthy and sons"
    },
    {
        "comment": false,
        "country_id": [ 105, "India" ],
        "id": 14,
        "name": "Best Designers"
    },
    {
        "comment": false,
        "country_id": [ 76, "France" ],
        "id": 17,
        "name": "Camptocamp"
    }
]

Create records

Records of a model are created using create(). The method creates a single record and returns its database identifier.

create() takes a mapping of fields to values, used to initialize the record. For any field which has a default value and is not set through the mapping argument, the default value will be used.

Note

PythonRubyPHPJava

id = models.execute_kw(db, uid, password, 'res.partner', 'create', [{'name': "New Partner"}])

Result:

78

Warning

While most value types are what would expect (integer for Integer, string for Char or Text),

• Date, Datetime and Binary fields use string values

• One2many and Many2many use a special command protocol detailed in the documentation to the write method.

Update records

Records can be updated using write(). It takes a list of records to update and a mapping of updated fields to values similar to create().

Multiple records can be updated simultaneously, but they will all get the same values for the fields being set. It is not possible to perform "computed" updates (where the value being set depends on an existing value of a record).

Note

PythonRubyPHPJava

models.execute_kw(db, uid, password, 'res.partner', 'write', [[id], {'name': "Newer partner"}])
# get record name after having changed it
models.execute_kw(db, uid, password, 'res.partner', 'name_get', [[id]])

Result:

[[78, "Newer partner"]]

Delete records

Records can be deleted in bulk by providing their ids to unlink().

Note

PythonRubyPHPJava

models.execute_kw(db, uid, password, 'res.partner', 'unlink', [[id]])
# check if the deleted record is still in the database
models.execute_kw(db, uid, password, 'res.partner', 'search', [[['id', '=', id]]])

Result:

[]

Inspection and introspection

While we previously used fields_get() to query a model and have been using an arbitrary model from the start, OpenSPP stores most model metadata inside a few meta-models which allow both querying the system and altering models and fields (with some limitations) on the fly over XML-RPC.

ir.model

Provides information about OpenSPP models via its various fields.

name

a human-readable description of the model

model

the name of each model in the system

state

whether the model was generated in Python code (base) or by creating an ir.model record (manual)

field_id

list of the model's fields through a One2many to ir.model.fields

view_ids

One2many to the Views defined for the model

access_ids

One2many relation to the Access Rights set on the model

ir.model can be used to

• Query the system for installed models (as a precondition to operations on the model or to explore the system's content).

• Get information about a specific model (generally by listing the fields associated with it).

• Create new models dynamically over RPC.

Important

• Custom model names must start with x_.

• The state must be provided and set to manual, otherwise the model will not be loaded.

• It is not possible to add new methods to a custom model, only fields.

Note

A custom model will initially contain only the "built-in" fields available on all models:

PythonPHPRubyJava

models.execute_kw(db, uid, password, 'ir.model', 'create', [{
    'name': "Custom Model",
    'model': "x_custom_model",
    'state': 'manual',
}])
models.execute_kw(db, uid, password, 'x_custom_model', 'fields_get', [], {'attributes': ['string', 'help', 'type']})

Result:

{
    "create_uid": {
        "type": "many2one",
        "string": "Created by"
    },
    "create_date": {
        "type": "datetime",
        "string": "Created on"
    },
    "__last_update": {
        "type": "datetime",
        "string": "Last Modified on"
    },
    "write_uid": {
        "type": "many2one",
        "string": "Last Updated by"
    },
    "write_date": {
        "type": "datetime",
        "string": "Last Updated on"
    },
    "display_name": {
        "type": "char",
        "string": "Display Name"
    },
    "id": {
        "type": "integer",
        "string": "Id"
    }
}

ir.model.fields

Provides information about the fields of OpenSPP models and allows adding custom fields without using Python code.

model_id

Many2one to ir.model to which the field belongs

name

the field's technical name (used in read or write)

field_description

the field's user-readable label (e.g. string in fields_get)

ttype

the type of field to create

state

whether the field was created via Python code (base) or via ir.model.fields (manual)

required, readonly, translate

enables the corresponding flag on the field

groups

field-level access control, a Many2many to res.groups

selection, size, on_delete, relation, relation_field, domain

type-specific properties and customizations, see the fields documentation for details

Important

• Like custom models, only new fields created with state="manual" are activated as actual fields on the model.

• Computed fields can not be added via ir.model.fields, some field meta-information (defaults, onchange) can not be set either.

Note

PythonPHPRubyJava

id = models.execute_kw(db, uid, password, 'ir.model', 'create', [{
    'name': "Custom Model",
    'model': "x_custom",
    'state': 'manual',
}])
models.execute_kw(db, uid, password, 'ir.model.fields', 'create', [{
    'model_id': id,
    'name': 'x_name',
    'ttype': 'char',
    'state': 'manual',
    'required': True,
}])
record_id = models.execute_kw(db, uid, password, 'x_custom', 'create', [{'x_name': "test record"}])
models.execute_kw(db, uid, password, 'x_custom', 'read', [[record_id]])

Result:

[
    {
        "create_uid": [1, "Administrator"],
        "x_name": "test record",
        "__last_update": "2014-11-12 16:32:13",
        "write_uid": [1, "Administrator"],
        "write_date": "2014-11-12 16:32:13",
        "create_date": "2014-11-12 16:32:13",
        "id": 1,
        "display_name": "test record"
    }
]

Note

This page is adapted from the Odoo documentation on External API.