Guides
GuidesAPI ReferenceNotificationsDiscussionsSupportStatus

Make Your First API Request

Before calling other API endpoints, verify that your API credentials and network connectivity are configured correctly.

Request your credentials

Request API credentials (username and password) with API user privileges. Contact Client Experience if you need assistance setting up access.

Authenticate your request

Encode your username:password pair using Base64 and include it in the Authorization header.

Make your first API call

To verify that you can connect to the Cleverbridge REST API, call the Test Connection endpoint:

curl --location 'https://rest.cleverbridge.com/connection/test' \
            --header 'Accept: application/json' \
            --header 'Authorization: Basic YOUR_BASE64_ENCODED_CREDENTIALS'

This resource validates that:

  • You can connect to rest.cleverbridge.com.
  • Your API user credentials are valid.
    Successful response
{
"Result": "OK"
}

A successful request returns HTTP 200 OK.

Status codes


StatusMeaning
200Connection successful
401Invalid API credentials
403API user lacks the required permissions


Updated 3 months ago

Did this page help you?