API integration

Most Progress Data Cloud interface actions have an equivalent in the Cloud Management REST API. Access to these endpoints is restricted by role.

Management API Details:

• From the Progress Data Cloud interface: navigation bar > > Management API.
• API details are also available in Swagger at https://{tenancy-URL}/swagger.

Additionally, each service has REST API endpoints:

• The endpoints that your Progress Data Cloud roles allow your account to access are on that service's service card.
• These endpoints are also on the service's API Details sidebar, where you can click to also access the service's API documentation.
• If you do not have Progress Data Cloud interface access, then see What APIs are available and how can I access them?

REST API integration steps

1. Get the API Key from the Account Settings page if you are using your personal account, or from your tenant administrators if you are using a service account.

   Note:

   • To aid with integration, the following sample script may be used to automate API key management: API key management PowerShell script.

   • Progress Data Cloud recommends using a service account when connecting applications to service integration endpoints. The default expiry for an API key is generally longer for service accounts than for regular user accounts.

2. Use the API key to generate a bearer token or access token by submitting a POST request to https://{tenancy-URL}/token with these parameters:

   • grant_type: apiKey

   • key: {API Key from the previous step.}

   • (Optional) duration: number of minutes that the token is valid. The maximum duration cannot be exceeded. The default value is typically 1 hour. See Default key duration for more information.

   For example:

   Copy

   curl -X POST -d "grant_type=apikey&key={API_key}" "https://{tenancy-URL}/token"
   

   The access_token and its expiry are returned in the JSON response:

   Copy

   {
       "statusCode": "<response status code, normally 200>",
       "access_token": "<encoded session token string>",
       "token_type": "bearer",
       "expires_in": "<number of minutes to expiry>",
       ".issued": "<date/time of session token generation>",
       ".expires": "<date/time of session token expiry>",
       "userName": "<name of user that issued the token>"
   }
   

3. Use the access_token as Authorization header of any API calls:

   Copy

   curl -H "Authorization: bearer {access_token}" https://{tenancy-URL}/ml/{target-endpoint}
   

General application response

The following error codes and behavior apply to all REST API endpoints. Service integration endpoints may also respond with similar or other response codes for other reasons. Check the corresponding documentation for more information.

HTTP status codes and responses: