Getting Started - Hyland Content REST API - Current - Current - Ready - Content Innovation Cloud - external

Hyland Content REST API
Platform
Content Innovation Cloud
Product
Hyland Content REST API
Release
Current
License

Before you can start using the Content REST API, you must complete some basic authentication steps. Using your Hyland Experience Identity Provider (IdP) connection and service application credentials, you can retrieve an access token and use it to request data from a protected resource to complete the authentication process. For more information on registering and assigning a service user to acquire service application credentials, see the service applications sections of the Hyland Experience Administration Portal documentation: Service Applications.

To complete authentication:

  1. Open Command Prompt or Terminal.
  2. Enter the following request to retrieve an access token: 
    curl -i -X POST [idp_url]/idp/connect/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials&client_id=[service_app_id]&client_secret=[service_app_secret]"

    where [idp_url] is the URL to your Hyland Experience IdP connection, [service_app_id] is your Hyland Experience service application's auto-generated client ID, and [service_app_secret] is your service application's client secret.

    A response similar to the following example is displayed:

    {
  "access_token": "eyJhbGcirwbcQmQA",
  "expires_in": 900,
  "token_type": "Bearer",
  "scope": "hxp hxp.integrations hxps openid"
}

    In this example, the eyJhbGcirwbcQmQA access token expires in 900 seconds (15 minutes).

    Note: Real access tokens are much longer than the simple, 16-character string used in the example token.
  3. To retrieve data from a protected resource, use your access token as you enter the following request: 
    curl -i -X GET [base_url]/hello/protected \
  -H "Authorization: Bearer [access_token]" \
  -H "User-Agent: [product]/[version]"

    where the placeholders represent the following:

    Placeholder Description
    [base_url] The URL of the Hyland Content repository
    [access_token] The access token you retrieved in step 2
    [product] The name of the software you are using to make the request
    [version] The numbered version of the software

    A response similar to the following example is displayed:

    Hello [idp_user_id]! Application status is: started

    where [idp_user_id] is your Hyland Experience account's alphanumeric user ID.

    For information on common next steps following authentication, see Tutorials.