If none of the pre-build web services match your needs, you can create a custom service i.e. select which of the standard web service functions are available via that service.
Step 1. Login as an administrator and select Administration.
Step 2. Select Administration
Step 3. Select Plugins Tab
Step 4. Locate the Web services category.
Step 5. Select External Services
Step 6. Select Add
Step 7. Complete the required fields.
|
Field |
Description |
|
Name |
Add a name |
|
Short name |
Add a short name |
|
Enabled |
If this box is checked, the webservice is enabled, if uncheck it will be disabled. |
|
Authorised users only |
This setting determines whether all users with the permission to create a web services token can generate a token for this service via their security keys page or whether only authorised users can do so. |
|
Can download files |
If enabled, any user can download files with their security keys. Of course they are restricted to the files they are allowed to download in the site. |
|
Can upload files |
If enabled, any user can upload files with their security keys to their own private files area or a draft file area. Any user files quotas apply. |
|
Required capability |
If set, only users with this capability can access the service. |
E.g.
Step 8. Scroll to the bottom of the screen and select Add service.
Step 9. Select Add functions, to add functions to the newly created external service.
Step 10. Type a keywords for the functions that you’d like to associate with this external service into the search bar, when you have found the function/s select them and they will be added, in purple, above the search bar.
Step 11. Once you have added all of the required functions, select Add functions.
The functions have now been added, if you need to add additional functions at any time by returning to this location and selecting Add functions.
Step 12. If you enabled authorised users only when setting up the new external service, return to the External Services page by following steps 1-5 in this how-to manual. Here select the Authorised users link in the users column, corresponding to the external service you are wanting to add authorised users too.
Step 13. Select the user that you’d like to authorise from the Not authorised users list. You can select multiple users if you use ctrl or command + click.
Step 14. Select Add.
The user will now appear in the authorised users list and is now an authorised user.
