Appearance
Urls
The following urls are used for the service
XMLRPC
domain.com/index.php/webservice/xmlrpc
SOAP
domain.com/index.php/webservice/soap (service only)
domain.com/index.php/webservice/soap?wsdl (wsdl only)
REST
The REST service has an intelligence for posting via GET
POST
PUT
DELETE
to an endpoint (name of the API, e.g. entry
channel
etc) or just call the method_name
as endpoint. For some API's you only can use the method_name
via an GET
POST
action.
HTTP Actions
domain.com/index.php/webservice/rest/<api_name>/<output>
According to the methods of an API, there are most of the time CRUD methods available (check the api for the methods). Based on the HTTP action GET
POST
PUT
DELETE
the module will check what api_name
you using and translate the HTTP action to read_
create_
update_
delete_
So for example, using the url domain.com/index.php/webservice/rest/entry/json
and make an POST
request to this url, will result in an create_entry
call.
See the table below how the HTTP actions are translated to the method of your api_name
HTTP action | Method |
---|---|
GET | read_ |
POST | create_ |
PUT | update_ |
DELETE | delete_ |
Get url
Just a simple way of query the url based on GET values.
- domain.com/index.php/webservice/rest/
<method_name>
/<output>
?<get_values>
- method_name: are methods like
create_entry
delete_entry
etc. - output: indicates the output. (
json
php
xml
) - get_values: all post values can also be passed as an array of get values. (
?auth[username]=test&auth[password]=test&data[title]=test&data[channel]=news
)
Auth via header in a REST request via the following key for auth: "webservice_auth_[field_name]
" data: "webservice_data_[field_name]
"