Difference between revisions of "Module Web Services API SOAP (developer)"

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search
VisualWikitext
m (Created page with '{{TemplateDocDevEn}} Dolibarr provide a server and a client for web services in directory htdocs/webservices. This server use embended php Nusoap library (no need to add PHP modu...')
 
m
Tag: 2017 source edit
 
(33 intermediate revisions by 3 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}}
−
Dolibarr provide a server and a client for web services in directory htdocs/webservices. This server use embended php Nusoap library (no need to add PHP module) modified to work with PHP4 and PHP5.
+
{{TemplateModEN}}
−
You can send your own SOAP request to thi server at URL
+
[[Category:List of Modules]]
−
  http://yourdolibarrvirtualhost/webservices/server.php
+
{{BasculeDevUserEn|
 +
name=Web services|
 +
num=2600|
 +
devdoc=This page|
 +
userdoc=Not applicable|}}
 +
 
 +
= 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.
 +
 
 +
[[File:warning.png]] 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
 +
{{TemplateListOfWebServices}}
 +
 
 +
 
 +
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'''
  
−
Only few services are available.
+
For example on Dolibarr demo, call the client user interface
 +
https://demo.dolibarr.org/webservices/demo_wsclient_other.php
  
−
You can see list of Dolibarr Webservices provided by calling the URL with no POST parameters. So just call the URL '''http://yourdolibarrvirtualhost/webservices/server.php''' to see list of available functions.
+
= 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/
  
−
Note that you can see an example of a PHP client calling this URL in page
+
This list is very short but will be completed with future Dolibarr versions...
−
http://yourdolibarrvirtualhost/webservices/server.php
 

Latest revision as of 12:51, 12 August 2019


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 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...

Retrieved from "https://wiki.dolibarr.org/index.php?title=Module_Web_Services_API_SOAP_(developer)&oldid=43501"