Module Web Services API REST (developer): Difference between revisions

When enabling this module, you enable usage of web services provided by Dolibarr server. You can then make REST call of different web services provided by Dolibarr.

Once module webservices REST is activated, Dolibarr become also a server of REST web services. So you can send your own REST request to relative URL

'''/api/index.php/xxx''' where xxx is name of the API to call.

However, NGinx default setup on a lot of distribution is often a gaz engine and you may experience troubles. If you experience suche troubles, you can try to edit your NGinx config file to match the following example. This is a simple localhost setup with a working REST API handling (tested with 9.0.1 on parabola gnu/linux).

worker_processes  1;

error_log  /var/log/nginx/error.log;

     }

}

Only few services are available. Starting to Dolibarr 5.0 version, you can see full list of Dolibarr Web services provided, by calling the explorer here at address:

You can then test directly from this explorer any API. This is the recommended solution to test any Dolibarr API since any API and parameters is documented here. As a result of any test, you will get the answer but also example on how to call the API from command line using '''curl'''.

To install, open the modules page and activate de API REST module. On the configuration page of the module, there's a link to an explorer. Click on it to open the API explorer.

On this exploration page of the API, you can do quite a lot of tests. Reading datas from Dolibarr and writing, modifying and deleting as well. Warning: Data are really modified in your database.

with one of the 4 following methods : GET, POST, PUT, DELETE, replacing <action> by the action you want to use. Ex : <nowiki>http://<my_server>/api/index.php/invoices</nowiki>

// Example of function to call a REST API

function callAPI($method, $apikey, $url, $data = false)

     return $result;

The fonction has 4 parameters :

==Accepted parameters==

This is documented somewhat in the REST Explorer. Check that first. Second try and see what response you get. Third look at the source code for the given API.

They are passed on to the database after a check.

These work on the product endpoint:

==Date==

The ISO date format is accepted: %Y-%m-%d e.g. 2020-07-14. yymmdd is not accepted.

This is more examples, for different uses cases:

In every examples, we have:

// Retrieve products list

$listProduits = [];

}

}

Comments :

// Create a product

$ref = "my_product_ref_X203ZZ";

$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));

$newProductResult = json_decode($newProductResult, true);

Comments :

// my ref

$ref = "my_product_ref_X203ZZ";

}

}

Comments :

Warning: The example below is not working properly. Creating an order and lines in one go is not supported. Instead you have to create an order first and with the returned order id add the lines using the /orders/{id}/lines endpoint.  

// create an order with 2 products

$newCommandeResult = json_decode($newCommandeResult, true);

}

Comments :

// Validate an order  

$newCommandeValider = [

$newCommandeValiderResult = json_decode($newCommandeValiderResult, true);

Comments :

$newCommandeResult is the ID of the order created in the previous example

// search in the database if a customer exist

$customer_name = "Acme Inc";

)

), true);

Comments :

// customer doesn't exist. Let's create it and get it's ID

$newClient = [

$newClientResult = json_decode($newClientResult, true);

$clientDoliId = $newClientResult;

Comments :

See https://pypi.org/project/dolipy/ and https://pypi.org/project/dolibarr/

Adding a new REST service is as easy than adding a file called '''api_mymoduleobject.class.php''' into the directory '''htdocs/mymodule/class'''.

You take the example into '''htdocs/commande/class/api_orders.class.php'''

These are just the basics.