Make your first API call

The quickest way to get started with Cleverbridge API

Prerequisites

Username and password with API user privilege: contact Client Experience if you need to set this up.

Step 1: Authentication

Use HTTP Basic Authentication (Basic Auth). To generate a valid authorization header, encode your Cleverbridge username and password in base64.

Step 2: Test your connection

To test your connection with our backend REST APIs, use the Test Connection resource:

curl --request GET \
  --url https://rest.cleverbridge.com/connection/test \
  --header 'accept: application/json'

import requests

url = "https://rest.cleverbridge.com/connection/test"

headers = {
    "accept": "application/json"
}

response = requests.get(url, headers=headers)

print("Status:", response.status_code)
print("Body:", response.text)

const url = "https://rest.cleverbridge.com/connection/test";

async function run() {
  const res = await fetch(url, {
    method: "GET",
    headers: {
      accept: "application/json",
    },
  });

  console.log("Status:", res.status);
  console.log("Body:", await res.text());
}

run();

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ConnectionTest {
    public static void main(String[] args) throws Exception {
        String url = "https://rest.cleverbridge.com/connection/test";

        HttpClient client = HttpClient.newHttpClient();

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create(url))
                .header("accept", "application/json")
                .GET()
                .build();

        HttpResponse<String> response =
                client.send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println("Status: " + response.statusCode());
        System.out.println("Body: " + response.body());
    }
}

This resource validates that:

You can connect with rest.cleverbridge.com.
Your API user credentials are valid.

{
  "ResultMessage": "OK"
}

Updated 5 months ago