Module Web Services API SOAP (developer)

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search


Return to developer
documentation index

File Doc dev.png

Return to
list of modules index

Art.png

Web services
Numero/ID of module 2600
User doc. of module Not applicable
Developer doc. of module This page

Function

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

Warning.png SOAP is a deprecated protocol. It is highly recommended to use the Module Web Services API REST (developer) instead.

Dolibarr web services server

Once module webservices is activated, Dolibarr become also a server of web services. So you can send your own SOAP request to relative URL /webservices/server_xxx.php where xxx can be

  • "actioncomm"
  • "category"
  • "contact"
  • "invoice"
  • "order"
  • "other"
  • "productorservice"
  • "supplier_invoice"
  • "thirdparty"
  • "user"


For example on Dolibarr demo, send your SOAP requests to https://demo.dolibarr.org/webservices/server_other.php


Only few services are available. You can see full list of Dolibarr Webservices provided, by calling the URL with no POST parameters.

For example, to see all Webservices functions available on Dolibarr demo, just call the following URL with no parameters:

https://demo.dolibarr.org/webservices/server_other.php

To get the WSDL file that describe webservices contracts, you can call:

https://demo.dolibarr.org/webservices/server_other.php?wsdl

Dolibarr web services client

Note that you can see an example of code for a PHP client calling this relative URL /webservices/server_other.php

For example on Dolibarr demo, call the client user interface

https://demo.dolibarr.org/webservices/demo_wsclient_other.php

List of provided services

List of available services can be viewed by calling the page /webservices/ on your Dolibarr installation. For example, for the demo Dolibarr server, full URL is: https://demo.dolibarr.org/webservices/

This list is very short but will be completed with future Dolibarr versions...