TOTVS Fluig English

Árvore de páginas

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.



Services

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

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

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

    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 window, select the service to be edited.

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

    03. Change the information of your choice.

    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  (test service).

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

    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  (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). 

    After enabling logging, the number of requests made by the respective service will be shown. To check the log expiration time, access the 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  (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.

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





    Please note!

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