Difference between revisions of "Module Web Services API SOAP (developer)"
m (moved Module Web Services to Module Web Services SOAP) |
m Tag: 2017 source edit |
||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | <!-- BEGIN origin interlang links --> | ||
| + | <!-- You can edit this section but do NOT remove these comments | ||
| + | Links below will be automatically replicated on translated pages by PolyglotBot --> | ||
| + | [[fr:Module Services Web API SOAP (développeur)]] | ||
| + | [[es:Módulo Services Web SOAP (programador)]] | ||
| + | <!-- END interlang links --> | ||
| + | |||
{{TemplateDocDevEn}} | {{TemplateDocDevEn}} | ||
{{TemplateModEN}} | {{TemplateModEN}} | ||
| Line 10: | Line 17: | ||
= Function = | = 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. | 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. | ||
| + | |||
| + | [[File:warning.png]] SOAP is a deprecated protocol. It is highly recommended to use the [[Module Web Services REST]] instead. | ||
= Dolibarr web services server = | = Dolibarr web services server = | ||
| Line 18: | Line 27: | ||
| − | For example on Dolibarr demo, send your SOAP requests to ''' | + | For example on Dolibarr demo, send your SOAP requests to '''https://demo.dolibarr.org/webservices/server_other.php''' |
| Line 24: | Line 33: | ||
For example, to see all Webservices functions available on Dolibarr demo, just call the following URL with no 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: | 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 = | = Dolibarr web services client = | ||
| Line 34: | Line 43: | ||
For example on Dolibarr demo, call the client user interface | 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 provided services = | ||
List of available services can be viewed by calling the page '''/webservices/''' on your Dolibarr installation. | 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: | + | 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... | This list is very short but will be completed with future Dolibarr versions... | ||
Latest revision as of 12:51, 12 August 2019
| 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.
SOAP is a deprecated protocol. It is highly recommended to use the Module Web Services REST 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...