Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

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.



Services

...

01. In the main menu, click Control Panel.

...

03. View available services



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.

...

Painel

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

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.

...

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.

...

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.

...