Appearance
API Webservice
Manage the webservice members via API calls
Compatibility
- EE3
- EE4
- EE5
- EE6
- EE7
Installation
The Webservice API comes natively with Webservice module.
Methods
create_webservice_member
Short name | Description | |
---|---|---|
member_id | The member ID from EE | Required (if membergroup_id is empty) |
membergroup_id | The membergroup ID from EE | Required (if member_id is empty) |
services | The services | Optional |
apis | The Api's | Optional |
shortkeys | The shortkeys | Optional |
active | Active | Optional |
Request
Array
(
[member_id] => 1
[services] => xmlrpc|soap
[apis] => entry|category
[shortkeys] => test_key1|key2
[active] => 1 //or 0
)
Response
Array
(
[message] =>
[success] =>
[metadata] => Array
(
[key] => your-new-key
[secret] => your-new-secret
[id] => the-id
)
)
read_webservice_member
Short name | Description | |
---|---|---|
member_id | The member ID from EE | Required (if membergroup_id or webservice_member_id is empty) |
membergroup_id | The membergroup ID from EE | Required (if member_id or webservice_member_id is empty) |
webservice_member_id | The webservice member ID | Required (if member_id or membergroup_id is empty) |
Request
Array
(
[member_id] => 1
)
update_webservice_member
Short name | Description | |
---|---|---|
member_id | The member ID from EE for searching the member | Required (if membergroup_id or webservice_member_id is empty) |
membergroup_id | The membergroup ID from EE for searching the member | Required (if member_id or webservice_member_id is empty) |
webservice_member_id | The webservice member ID for searching the member | Required (if member_id or membergroup_id is empty) |
services | The services | Optional |
apis | The Api's | Optional |
shortkeys | The shortkeys | Optional |
active | Active | Optional |
Request
Array
(
[member_id] => 1
[services] => xmlrpc|soap
[apis] => entry|category
[shortkeys] => test_key1|key2
[active] => 1 //or 0
)
delete_webservice_member
Short name | Description | |
---|---|---|
member_id | The member ID from EE | Required (if membergroup_id or webservice_member_id is empty) |
membergroup_id | The membergroup ID from EE | Required (if member_id or webservice_member_id is empty) |
webservice_member_id | The webservice member ID | Required (if member_id or membergroup_id is empty) |
Request
Array
(
[member_id] => 1
)