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

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;

     }

}

= List of provided services =

// Example of function to call a REST API

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

     return $result;

* $apiUrl = "<nowiki>http://<my_server>/api/index.php/</nowiki>";

// Retrieve products list

$listProduits = [];

}

}

Comments :

* I retrieve the 10'000 first products sorted on their ID in the base

// Create a product

$ref = "my_product_ref_X203ZZ";

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

$newProductResult = json_decode($newProductResult, true);

Comments :

* before creating a product, it could be wise to check if it exists. Using my first example, you'll have  :

// my ref

$ref = "my_product_ref_X203ZZ";

}

}

Comments :

* I check if the ref of my product exist in the array created in the first example.

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 :

* $clientDoliId is the ID of the customer in the Dolibarr database. Either you know it or you can search for it before

// Validate an order  

$newCommandeValider = [

$newCommandeValiderResult = json_decode($newCommandeValiderResult, true);

Comments :

* in this example, on the penultimate line, we can see : $apiUrl."orders/".$newCommandeResult."/validate".<br/>

// search in the database if a customer exist

$customer_name = "Acme Inc";

)

), true);

Comments :

* limit => 1 only 1 customer

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

$newClient = [

$newClientResult = json_decode($newClientResult, true);

$clientDoliId = $newClientResult;

Comments :

* client => 1 He is a customer (not a supplier)