Index
Speaking of services...
Services allow you to safely access features and services outside the platform, using the authentication protocols OAuth 1, OAuth 2, and Basic authentication.
This feature allows you to register and configure services. For more technical and detailed information, see REST Services client authorization.
Basic path
01. In the main menu, click Control Panel.
02. In the General tab, click Services.
03. View available services
Alternative paths
Filtering by type
01. Select the type(s) of service(s) to be viewed: SOAP, JDBC or REST.
02. The information on the selected filter(s) is listed below.
Adding services
01. In the Services window, click New service.
02. Select the type of service to be added: SOAP, JDBC or REST.
03. Enter the required information.
The fields highlighted with an asterisk (*) are mandatory.
When the selected type is SOAP, the fields to be filled are:
- Name: to this field, add a name for the service to be registered.
- Description: to this field, add a description for the service.
- URL: to this field, add the URL of the webservice to be used.
- Bindingfile: The binding file will only be used for services created using CXF API. To add it, simply click Choose file in the Binding File field and add it.
For more details about binding, see our technical documentation on Integration with External Applications
When the selected type is REST, the fields to be filled are:
- Name:in this field, add a name for the service to be registered.
- Description: in this field, add a description for the service.
- Swagger: in this field, add an address for a JSON file.
The Swagger field will only be filled when the type of created service is Rest.
The swagger path of the api to be used will be added to this field.
When the selected type is JDBC, the fields to be filled are:
- Name: to this field, add a name for the service to be registered.
- Description: to this field, add a description for the service.
- Driver: in this field, select the driver of your choice: MySQL, SQLServer or Oracle.
- URL: to this field, add the URL of the webservice to be used.
- User: database access user.
- Password: database access password.
04. Click Save.
Editing services
01. In the Services window, select the service to be edited.
02. Click Edit, in the right corner of the screen, indicated by the pencil icon.
03. Change the information of your choice.
04. Click Save.
Testing REST services
01. In the Services window, select the Rest service to be tested.
Only REST services have the test option.
02. Click Test service, located to the right side of the Delete icon
Deleting services
01. In the Services window, select the service to be deleted.
02. Click Delete.
03. In the pop-up message, click Yes, delete service to confirm deletion of the service.
Please note!
This documentation is valid as of the 1.5.10 update. If you use a previous update, it may contain information different from what you see on your platform.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas