Maintenance APIs - EcoSys - Customization & Programming - Hexagon

EcoSys Web Service API Usage Documentation

Language
English
Product
EcoSys
Search by Category
Customization & Programming
EcoSys Version
9.1

API settings to register Connect Trusted App

The following API is used to register the Connect Trusted App in EcoSys. This API support only POST method and the user must have either sysadmin, sysadminplususer, or sysadminplusratetable license type to run this API.

http://host:port/ecosys/maintenance/trustedApp?_username=<user>&_password=password

  1. From the EcoSys application, navigate to System Admin –> Application Settings.

  2. Click Trusted Apps tab.

  3. By default, Connect Trusted app is not set.

  4. In the OAuth Client Credentials tab, enter the details below:

    1. App URL– EcoSys Connect URL, https://<host.name>/connect

    2. Token URL– Enter the Token URL of OAuth provider

    3. Client ID – Specify the Client ID of OAuth provider

    4. Client Secret – Specify the client secret from OAuth provider.

    5. Scope – Specify the scope from OAuth provider.

  5. Click Save under Operation field.

    The trusted app gets registered in EcoSys.

    Input

    The API accepts application/json content-type input of the form.

    HTTP return codes

    1. 200 (ok) - if there was an issue with the data, for eg. invalid 'appName'

    2. 204 (no content) - if everything worked properly

    3. 400 (bad request) - missing credentials, missing attributes in the JSON

    4. 401 (unauthorized) - invalid credentials, not enough privilege, any login related exceptions

    5. 500 (server error) - system and other unexpected exceptions

      In the case of HTTP 200, the response is of the form –

New APIs for Encription

The following are the 3 new interfaces -

  • To create ciphertext for use in EcoSys - http://host:port/ecosys/maintenance/ciphertext/ecosys?_username=<user>&_password=password

  • To create ciphertext for use in Connect - http://host:port/ecosys/maintenance/ciphertext/connect?_username=<user>&_password=password

  • To create encrypted text for use in ActiveMQ -  http://host:port/ecosys/maintenance/encrypt/activemq ?_username=<user>&_password=password

All the three interfaces only support the POST method. The user must have either sysadmin, sysadminplususer, or sysadminplusratetable license type to run this API.

HTTP return codes

  • 200 (ok) - success

  • 400 (bad request) - missing credentials, missing attributes in the JSON

  • 401 (unauthorized) - invalid credentials, not enough privilege, any login related exceptions

  • 500 (server error) - system and other unexpected exceptions

New APIs for Encryption Output