PHPackages flux-se/odoo-api-client - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [HTTP & Networking](/categories/http) 4. / 5. flux-se/odoo-api-client ActiveLibrary[HTTP & Networking](/categories/http) flux-se/odoo-api-client ======================= Odoo API client library (consume JSON or XML RPC API) v1.2.0(2mo ago)43.2k↓50%2MITPHPPHP >=8.1CI passing Since Feb 12Pushed 2mo ago2 watchersCompare [ Source](https://github.com/FLUX-SE/odoo-api-client)[ Packagist](https://packagist.org/packages/flux-se/odoo-api-client)[ RSS](/packages/flux-se-odoo-api-client/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (10)Dependencies (43)Versions (14)Used By (0) [![Latest Version on Packagist](https://camo.githubusercontent.com/30c3cf8780f60857840b9cde0ac3a28bc44056aadccebc85fdaa85fec0ba6146/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f666c75782d73652f6f646f6f2d6170692d636c69656e742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/flux-se/odoo-api-client)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE)[![Build Status](https://github.com/FLUX-SE/odoo-api-client/workflows/Build/badge.svg)](https://github.com/FLUX-SE/odoo-api-client/actions?query=workflow%3A%22Build%22) Odoo API client =============== [](#odoo-api-client) Odoo (formerly OpenERP) is a Belgian suite of business management software tools (PGI) : . This library allow communication trough Odoo JSON-RPC or XML-RPC API. Documentation about it can be found here (for the XML-RPC one, none for the JSON-RPC) : [https://www.odoo.com/documentation/master/developer/reference/external\_api.html](https://www.odoo.com/documentation/master/developer/reference/external_api.html) This library will allow you to : - Generate PHP model classes based on the info available into your own Odoo database to ease your calls to the API - Send requests to your Odoo instance through the JSON-RPC or the XML-RPC API - Make raw requests like [Ripcord](https://github.com/poef/ripcord) was doing it but using newer libs like : - `php-http/httplug` to make http requests - `symfony/serializer` to handle the JSON/XML-RPC format and to transform resulting array to dedicated object classes. Installation ------------ [](#installation) ### Composer [](#composer) Install using Composer : ``` composer require \ flux-se/odoo-api-client \ php-http/guzzle7-adapter \ http-interop/http-factory-guzzle ``` > `php-http/guzzle7-adapter` and `http-interop/http-factory-guzzle` are 2 requirements which can be chosen among [php-http/client-implementation](https://packagist.org/providers/php-http/client-implementation) and [psr/http-factory-implementation](https://packagist.org/providers/psr/http-factory-implementation) ### Object models generation [](#object-models-generation) **First gather required credential and database info described [here](https://www.odoo.com/documentation/master/developer/reference/external_api.html#connection).** Depending on your Odoo instance the object models available will be different, that's why this library is allowing you to generate model classes using this cli command : > This command is using env vars to guess the credentials and database info, you can use those env vars to set your credential globally : > > - `ODOO_API_HOST` > - `ODOO_API_DATABASE` > - `ODOO_API_USERNAME` > - `ODOO_API_PASSWORD` ``` #> vendor/bin/odoo-model-classes-generator --help Usage: vendor/bin/odoo-model-classes-generator [options] [--] Arguments: basePath The path where classes will be generated (ex: ./src/OdooModel/Object) baseNamespace The base namespace of the generated classes (ex: "App\OdooModel\Object") Options: --host[=HOST] Your Odoo base host (default: http://localhost:8069) [default: "http://localhost:8069"] --database[=DATABASE] Your Odoo database name (default: odoo-master) [default: "odoo-master"] --username[=USERNAME] Your Odoo account username. (default: admin) [default: "admin"] --password[=PASSWORD] Your Odoo account password or API key (since Odoo v14, default: admin) [default: "admin"] --only-model[=ONLY-MODEL] Filter the model list with the model you will set in this option. (multiple values allowed) --exclude-model[=EXCLUDE-MODEL] Filter the model list excluding the model you will set in this option. (multiple values allowed) -h, --help Display help for the given command. When no command is given display help for the vendor/bin/odoo-model-classes-generator command -q, --quiet Do not output any message -V, --version Display this application version --ansi Force ANSI output --no-ansi Disable ANSI output -n, --no-interaction Do not ask any interactive question -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug Example : ./vendor/bin/odoo-model-classes-generator \ --host http://localhost:8069 \ --database odoo-master \ --username admin \ --password admin \ ./src/OdooModel/Object \ "App\\OdooModel\\Object" ``` Introduction ------------ [](#introduction) This chapter will describe how the two Odoo APIs are working. JSON-RPC (Click me to see detailed info)### JSON-RPC [](#json-rpc) The Odoo JSON-RPC API expose 1 main endpoint `/jsonrpc`. The body request payload is a JSON object with specific data into it : ``` { "jsonrpc": "2.0", "method": "call", "params": [ { "service": "common", "method": "login", "args": [ "database", "username", "password" ] } ], "id": 123456890 } ``` The service param can be set with those 3 values : - `db` allowing to manage the postgres database - `common` allowing to authenticate a user or get info about the Odoo installation - `object` allowing operations with all API exposed models This library help you to use those endpoints using `ext-json` and `HttPlug`, **it also allows you to consume Odoo API using PHP classes representation of all installed Odoo Models**. XML-RPC (Click me to see detailed info)### XML-RPC [](#xml-rpc) The Odoo XML-RPC API expose 3 main endpoints : - `/xmlrpc/2/db` allowing to manage the postgres database - `/xmlrpc/2/common` allowing to authenticate a user or get info about the Odoo installation - `/xmlrpc/2/object` allowing operations with all API exposed models This library help you to use those endpoints using `ext-xmlrpc` and `HttPlug`, **it also allows you to consume Odoo API using PHP classes representation of all installed Odoo Models**. The authentication is not standard (compare to other APIs), your username and your password will be used during a call to `/xmlrpc/2/common` with the XML-RPC method `authenticate` (or `login`) returning your Odoo user id (`uid`). This uid, your password and your Odoo database name are required to make every request calls to the `/xmlrpc/2/object` endpoint. Usage example ------------- [](#usage-example) Using this library you will be able to use two ways of consuming the Odoo XML-RPC API : 1. using array 2. using object model classes ### Using Array [](#using-array) List your first partner (Contact) : ``` $loader = require_once( __DIR__.'/vendor/autoload.php'); use FluxSE\OdooApiClient\Builder\OdooApiClientBuilder; use FluxSE\OdooApiClient\Operations\Object\ExecuteKw\Options\SearchReadOptions; use FluxSE\OdooApiClient\Operations\Object\ExecuteKw\RecordListOperations; use FluxSE\OdooApiClient\Operations\Object\ExecuteKw\Arguments\Criterion; use FluxSE\OdooApiClient\Operations\Object\ExecuteKw\Arguments\SearchDomains; $host = 'https://myapp.odoo.com'; $database = 'myapp'; $username = 'myemail@mydomain.tld'; $password = 'myOdooUserApiKey'; // 1 - instantiate the Odoo API client builder $odooApiClientBuilder = new OdooApiClientBuilder($host); // 2 - service allowing to query Odoo API using `execute_kw` method $recordListOperations = $odooApiClientBuilder->buildExecuteKwOperations( RecordListOperations::class, $database, $username, $password ); // 3.1 - Helper class to set parameters to your request $searchDomains = new SearchDomains(); $searchDomains->addCriterion(Criterion::equal('is_company', true)); // will be translated to : [['is_company', '=', true]] // 3.2 - Helper class to set options to your request $searchReadOptions = new SearchReadOptions(); $searchReadOptions->setLimit(1); $searchReadOptions->addField('name'); // 3.3 - Search for the first Partner being a company and only return its name $partners = $recordListOperations->search_read('res.partner', $searchDomains, $searchReadOptions); dump($partners); /** array:1 [ 0 => array:2 [ "id" => 1 "name" => "My Partner" ] ] **/ ``` > By default, the **JSON-RPC** API will be used, if you want to use XML-RPC create an Odoo Api Client builder like this : > > ``` > use FluxSE\OdooApiClient\Api\OdooApiRequestMakerInterface; > use FluxSE\OdooApiClient\Builder\OdooApiClientBuilder; > > $odooApiClientBuilder = new OdooApiClientBuilder( > $host, > OdooApiRequestMakerInterface::BASE_XMLRPC_PATH > ); > ``` Using object model ------------------ [](#using-object-model) First you can generate classes based on the Odoo instance you have, for example: ``` bin/odoo-model-classes-generator \ "./src/Odoo/Model/Object" \ "App\\Odoo\\Model\\Object" \ --only-model=res.partner ``` > 💡 Here we are generating only one class, but you can also generate all classes excluding some of them (see info [here](#object-models-generation)). ``` $loader = require_once( __DIR__.'/vendor/autoload.php'); use App\Odoo\Model\Object\Res\Partner; use FluxSE\OdooApiClient\Builder\OdooApiClientBuilder; use FluxSE\OdooApiClient\Manager\ModelListManager; use FluxSE\OdooApiClient\Operations\Object\ExecuteKw\RecordListOperations; use FluxSE\OdooApiClient\Operations\Object\ExecuteKw\Arguments\Criterion; use FluxSE\OdooApiClient\Operations\Object\ExecuteKw\Arguments\SearchDomains; $host = 'https://myapp.odoo.com'; $database = 'myapp'; $username = 'myemail@mydomain.tld'; $password = 'myOdooUserApiKey'; // 1 - Instantiate the Odoo API client builder $odooApiClientBuilder = new OdooApiClientBuilder($host); // 2 - Service allowing to query Odoo API using `execute_kw` method $recordListOperations = $odooApiClientBuilder->buildExecuteKwOperations( RecordListOperations::class, $database, $username, $password ); // 3 - Service allowing to return object instead of raw array data $modelListManager = new ModelListManager( $odooApiClientBuilder->buildSerializer(), $recordListOperations ); // 4.1- Helper class to set parameters to your request $searchDomains = new SearchDomains(); $searchDomains->addCriterion(Criterion::equal('is_company', true)); // will be translated to : [['is_company', '=', true]] // 4.2 - Search for the first Partner being a company $partner = $modelListManager->findOneBy(Partner::class, $searchDomains); dump($partner); /** App\Odoo\Model\Object\Res\Partner {#1234 #name: "My test company" #date: DateTimeImmutable @1577880060 {#1234 date: 2020-01-01 12:01:00.123456 UTC (+00:00) } #is_company: true ... #id: 1 #display_name: "My test company" #__last_update: DateTimeImmutable @1577923260 {#5678 date: 2020-01-02 00:01:00.123456 UTC (+00:00) } } **/ ``` Know issues =========== [](#know-issues) - Since Odoo v16 some new fields can produce 500 errors, I try to create issues about them when I get the error, you can found the relates issues here : Development =========== [](#development) Using docker ------------ [](#using-docker) ``` docker run -d -p 5432:5432 -e POSTGRES_USER=odoo -e POSTGRES_PASSWORD=odoo -e POSTGRES_DB=postgres --name db postgres docker run --rm --pull always -p 8069:8069 --name odoo -e "HOST=host.docker.internal" -t odoo:14 -- --database odoo-master --init "l10n_fr,account_accountant" ``` The server is fully ready to use when this log line appears (Odoo v13 could take longer than upper version to reach this line) : ``` 2030-01-01 00:00:00,000 1 INFO odoo-master odoo.modules.loading: Modules loaded. ``` Generate the model classes based on the docker Odoo instance : > This script will use env vars to gather info about the Odoo instance you are targeting (see info [here](#object-models-generation)). ``` bin/odoo-model-classes-generator \ "./tests/TestModel/Object" \ "Tests\\FluxSE\\OdooApiClient\\TestModel\\Object" ``` Test the code against the generated classes from your own Odoo instance ``` vendor/bin/ecs check tests vendor/bin/psalm vendor/bin/phpunit ``` ### Health Score 51 — FairBetter than 96% of packages Maintenance85 Actively maintained with recent releases Popularity26 Limited adoption so far Community11 Small or concentrated contributor base Maturity69 Established project with proven stability Bus Factor1 Top contributor holds 99.7% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~167 days Recently: every ~158 days Total 12 Last Release 78d ago Major Versions v0.0.1 → v1.0.02023-08-09 PHP version history (3 changes)v0.0.1PHP ^7.3 v1.0.0PHP ^8.0 v1.0.4PHP >=8.1 ### Community Maintainers ![](https://www.gravatar.com/avatar/970e9207938e33441b0b7e3207c46b4df8ed7f020c77e40793812405ae8b0a3b?d=identicon)[Prometee](/maintainers/Prometee) --- Top Contributors [![Prometee](https://avatars.githubusercontent.com/u/861820?v=4)](https://github.com/Prometee "Prometee (311 commits)")[![rey26](https://avatars.githubusercontent.com/u/26801450?v=4)](https://github.com/rey26 "rey26 (1 commits)") --- Tags httpjsonapiclientxmlgeneratorserializerhttplugodoojson-rpcxml-rpcdto ### Code Quality TestsPHPUnit Static AnalysisPHPStan, Rector Code StyleECS Type Coverage Yes ### Embed Badge ![Health badge](/badges/flux-se-odoo-api-client/health.svg) ``` [![Health](https://phpackages.com/badges/flux-se-odoo-api-client/health.svg)](https://phpackages.com/packages/flux-se-odoo-api-client) ``` ### Alternatives [sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.4k5.6M651](/packages/sylius-sylius)[phpro/http-tools HTTP tools for developing more consistent HTTP implementations. 28137.8k](/packages/phpro-http-tools)[nelmio/api-doc-bundle Generates documentation for your REST API from attributes 2.3k63.6M233](/packages/nelmio-api-doc-bundle)[api-platform/core Build a fully-featured hypermedia or GraphQL API in minutes! 2.6k48.1M236](/packages/api-platform-core)[php-http/httplug-bundle Symfony integration for HTTPlug 38921.0M54](/packages/php-http-httplug-bundle)[api-platform/serializer API Platform core Serializer 223.4M31](/packages/api-platform-serializer) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)