TOTVS Fluig English

Árvore de páginas

Versões comparadas

Versão antiga 9

changes.mady.by.user Andressa Aparecida De Souza Heck

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Denise De Deus

Gravado em

Chave

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

Index

Índice
maxLevel4
outlinetrue
exclude.*ndex
stylenone


Speaking of

...

services...

REST 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  
This feature allows you to register , and configure and test these services.  For For more technical and detailed information, see  see REST services Services client authorization.

...



Services

...

01.  From In the main menu, click on Control panel Control Panel, then check Development container and click Services.

02. Click on the WCM tab.

03. Click on REST Services.

04. View the existing REST services.

Alternative paths

 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

...

service

...

01. In the REST Services window, click on Add New service.

02. Select the type of service to be added: SOAP, JDBC or REST.

03. Enter the required information.

Painel

The fields highlighted with an asterisk (*) are mandatory.

Code
Service identification code. 

Domain
 Address corresponding to the service domain. Example: http://127.0.0.1:8080. 

Authentication type
Authentication protocol that will be used by the service. The available options are:
- OAuth 1;
- OAuth 2;
- Basic.

Consumer key
 Key to access the service. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 1".

Consumer secret
 Secrete key to access the service. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 1".

Access token
 Token to access the service. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 1" or "Rest OAuth 2".

Secret token
 Secrete token to access the service. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 1".

Access token URL
URL for the token used to access the provider. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 1".

Token request URL
URL for the token used to request the provider. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 1".

User authorization URL
URL for the user's access authorization to the provider. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 1".

Client Id.
Unique client key. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 2". 

Client secret
Secret client key. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 2".  

Refresh token
Key to refresh token. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 2".  

Refresh token URL
URL to refresh token. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 2".

User
User sent in the request header.

Password
Password sent in the request header. 

Password confirmation
Confirmation of password sent in the request header.

URL for service test
Endpoint GET to test authentication of access to the provider.

03. Click on Save.

Edit REST service 

Deck of Cards
historyfalse
idServices
Card
id1
labelSOAP

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
Card
id2
labelREST

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.

  • Domain: in this field, add the service domain.
  • Authentication type: in this field, select the type of authentication: None, Rest oauth 1, Rest oauth 2, Custom, Basic.
    For more details on how to properly fill out the authentication settings, see the Fluig API technical documentation.
  • URL for service test: in this field, add GET endpoint for provider authentication test.
Card
id3
labelJDBC

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 service

...

01. In the Services 01. On the REST services window, select the service to be edited.

02. Click on Edit Edit, in the right corner of the screen, indicated by the icon Image Added (pencil).

03. Change the information of your choice.

Painel

For more details about the fields displayed, see Add REST service.

04 . Click on Save.

Remove REST service 

01. On the REST services window, select the service to be removed.

02. Click Delete.

03. In the message that opens, click on Confirm to remove the service.

Test REST service 

01. On the REST services window, select the service that you wish to test.

02. Click on Test service

03. In the window displayed, click on Test service again.

...

04. Click Save.



Testing service

...

01. In the Services window, select the service to be tested.

02. In the right corner of the screen, click Image Added (test service).

02. In the pop-up message, click Test service to confirm.

Painel

The test is only carried out for REST or JDBC services. The Test service window has a field containing the test return (success or error).




Enable logging

...

01. In the Services window, find the service to generate the log.

02. In the log column, click Image Added (Usage Statistics).

03. In the Usage Statistics window, click ON to enable logging.

04. In the confirmation message, select Yes, I want to enable the log.

05. Set the log expiration time (1 to 24 hours). 

Painel

After enabling logging, the number of requests made by the respective service will be shown. To check the log expiration time, access the Image Added icon next to the “Expiration time” field.



Deleting service

...

01. In the Services window, select the service to be deleted.

02.  In the right corner of the screen, click Image Added (remove).

03. In the pop-up message, click Yes, delete the service to confirm deletion of the service.



Download the log

...

01. In the Services window, click the Log download button.

Painel

Select this option to download the server log file containing all errors occurred during integration with external systems.





Informações
titlePlease note!

This documentation is valid as of the from the Liquid (1.6.5.10 ) update. If you use a previous update, it may contain information different from what you see on your platform.

...