Module Web Services API REST (developer) - Revision history

Eldy: /* List of provided services */

2026-09-06T15:41:00Z

List of provided services

← Older revision		Revision as of 15:41, 6 September 2026
Line 100:		Line 100:
	For example, you can try the explorer on the demo instance at:		For example, you can try the explorer on the demo instance at:

	'''https://~~demo~~.dolibarr.org/api/index.php/explorer'''		'''https://preview.dolibarr.org/api/index.php/explorer'''

			The swagger file to describe all available API services can be found at:

			'''https://preview.dolibarr.org/api/index.php/explorer/swagger.json?DOLAPIKEY=demokey'''

Eldy: /* Use */

2026-05-29T09:40:04Z

Use

← Older revision		Revision as of 09:40, 29 May 2026
Line 125:		Line 125:
	You will have to use this API key in any of your client program that need to call a Dolibarr API. The API key must be provided as a HTTP header "DOLAPIKEY: apikey".		You will have to use this API key in any of your client program that need to call a Dolibarr API. The API key must be provided as a HTTP header "DOLAPIKEY: apikey".

	If you are using the multicompany module, you can also force the API to be executed as if you were logged into a given entity by adding the HTTP header "DOLAPIENTITY: ~~identity~~"		If you are using the multicompany module, you can also force the API to be executed as if you were logged into a given entity by adding the HTTP header "DOLAPIENTITY: idOfEntity"

Eldy: /* Use */

2025-11-01T11:05:39Z

Use

← Older revision		Revision as of 11:05, 1 November 2025
Line 123:		Line 123:


	You will have to use this API key in any of your client program that need to call a Dolibarr API.		You will have to use this API key in any of your client program that need to call a Dolibarr API. The API key must be provided as a HTTP header "DOLAPIKEY: apikey".

			If you are using the multicompany module, you can also force the API to be executed as if you were logged into a given entity by adding the HTTP header "DOLAPIENTITY: identity"

Eldy: /* Examples with PHP */

2024-08-07T12:27:00Z

Examples with PHP

← Older revision		Revision as of 12:27, 7 August 2024
Line 401:		Line 401:
	"email" => "customer company email",		"email" => "customer company email",
	"client" => "1",		"client" => "1",
	"code_client" => "-1"		"code_client" => "auto"
	];		];
	$newClientResult = CallAPI("POST", $apiKey, $apiUrl."thirdparties", json_encode($newClient));		$newClientResult = CallAPI("POST", $apiKey, $apiUrl."thirdparties", json_encode($newClient));
Line 407:		Line 407:
	$clientDoliId = $newClientResult;		$clientDoliId = $newClientResult;
	</syntaxhighlight>		</syntaxhighlight>
	~~Comments :~~

	*client => 1 He is a customer ~~(not a supplier)~~		Comments:
	*code_client => -1 so the customer code will be generated automatically.		*client => 1, he is a customer.
			*code_client => 'auto' so the customer code will be generated automatically.
	*we get the customer ID in $clientDoliId		*we get the customer ID in $clientDoliId

Jonbendtsen: inserted link to Dolibarrpy and put year numbers after all 3 modules with the latest release.

2024-08-03T16:04:15Z

inserted link to Dolibarrpy and put year numbers after all 3 modules with the latest release.

← Older revision		Revision as of 16:04, 3 August 2024
Line 414:		Line 414:

	=Examples with Python=		=Examples with Python=
	See https://pypi.org/project/dolipy/ ~~and~~ https://pypi.org/project/dolibarr/		See https://pypi.org/project/dolipy/ (2021) or https://pypi.org/project/dolibarr/ (2019) or https://pypi.org/project/dolibarrpy/ (2024)

	First you can install the python-module with "pip install dolibarr".		First you can install the python-module with "pip install dolibarr" or pypi install dolibarrpy

	<~~syntaxHighlight~~ lang=python>		<syntaxhighlight lang="python">
	from dolibarr import Dolibarr		from dolibarr import Dolibarr

Line 442:		Line 442:
	product_dict = dolibarr_inst.call_list_api('products')		product_dict = dolibarr_inst.call_list_api('products')
	print(product_dict)		print(product_dict)
	</~~syntaxHighlight~~>		</syntaxhighlight>

	=Develop your own service / API=		=Develop your own service / API=

ShengGang: Add Chinese

2023-10-09T03:15:57Z

Add Chinese

← Older revision		Revision as of 03:15, 9 October 2023
Line 4:		Line 4:
	[[fr:Module_Web_Services_API_REST_(développeur)]]		[[fr:Module_Web_Services_API_REST_(développeur)]]
	[[ja:Module_Web_Services_API_REST_(developer)_JA]]		[[ja:Module_Web_Services_API_REST_(developer)_JA]]
			[[zh:提供REST_API的Web服务模块（开发者）]]
	<!-- END interlang links -->		<!-- END interlang links -->

Line 14:		Line 15:
	devdoc=This page\|		devdoc=This page\|
	userdoc=Not applicable\|}}		userdoc=Not applicable\|}}








	=Function=		=Function=

Eldy at 21:32, 24 July 2023

2023-07-24T21:32:45Z

← Older revision		Revision as of 21:32, 24 July 2023
Line 3:		Line 3:
	Links below will be automatically replicated on translated pages by PolyglotBot -->		Links below will be automatically replicated on translated pages by PolyglotBot -->
	[[fr:Module_Web_Services_API_REST_(développeur)]]		[[fr:Module_Web_Services_API_REST_(développeur)]]
			[[ja:Module_Web_Services_API_REST_(developer)_JA]]
	<!-- END interlang links -->		<!-- END interlang links -->

Eldy: /* Develop your own service / API */

2023-02-02T21:26:06Z

Develop your own service / API

← Older revision		Revision as of 21:26, 2 February 2023
Line 451:		Line 451:
	=Develop your own service / API=		=Develop your own service / API=
	Adding a new REST service is as easy than adding a file called '''api_mymoduleobject.class.php''' into the directory '''htdocs/mymodule/class'''.		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'''		You can take an example into '''htdocs/commande/class/api_orders.class.php'''

	Note that if you use the '''modulebuilder''' tool, ~~the~~ file may be generated for you.		Note that if you use the '''modulebuilder''' tool, this file may be generated for you.

	The framework detects automatically the API and it should be visible into the explorer.		The framework detects automatically the API files and it should be visible into the explorer.

	Method and parameters are detected according to introspection done into PHP class of the object ('''htdocs/mymodule/class/object.class.php''') using the '''annotations''' found into the class.		Method and parameters are detected according to introspection done into PHP class of the object ('''htdocs/mymodule/class/object.class.php''') using the '''annotations''' found into the class.
Line 462:		Line 462:
	These are just the basics.		These are just the basics.

	~~Some more informations~~ in ~~the~~ Dolibarr ~~code. You~~ can ~~look here :~~ htdocs/<directory>/class/api_xxx_class.php~~<br />~~		To find all existing API files in Dolibarr, you can search all files htdocs/<directory>/class/api_xxx_class.php
	~~Ex : htdocs/societe/class/api_thirdparties.class.php for thirdparties.<br />~~
	~~Ex : htdocs/societe/class/api_contacts.class.php for contacts.<br />~~
	~~Ex : htdocs/compta/facture/class/api_invoice_class.php for invoices.<br />~~
	~~Ex : htdocs/mrp/class/api_mos_class.php for manufacturing orders.<br />~~
	~~Ex : htdocs/product/class/api_products.class.php for contacts.<br />~~

Eldy: /* Examples with Python */

2023-02-02T21:21:38Z

Examples with Python

← Older revision		Revision as of 21:21, 2 February 2023
Line 423:		Line 423:
	First you can install the python-module with "pip install dolibarr".		First you can install the python-module with "pip install dolibarr".

	<~~br /~~>		<syntaxHighlight lang=python>
	from dolibarr import Dolibarr		from dolibarr import Dolibarr

Line 447:		Line 447:
	product_dict = dolibarr_inst.call_list_api('products')		product_dict = dolibarr_inst.call_list_api('products')
	print(product_dict)		print(product_dict)
			</syntaxHighlight>

	=Develop your own service / API=		=Develop your own service / API=

Eldy: /* Use */

2022-09-12T22:31:57Z

Use

← Older revision		Revision as of 22:31, 12 September 2022
Line 124:		Line 124:

	Before using any API, you must first get a custom API-key. You have to create a new user and generate or set its "Key for API".		Before using any API, you must first get a custom API-key. You have to create a new user and generate or set its "Key for API".

	[[File:Dolibarr user for api.png\|400px]]		[[File:Dolibarr user for api.png\|400px]]


	You will have to use this API key in any of your client program that need to call a Dolibarr API.		You will have to use this API key in any of your client program that need to call a Dolibarr API.