Start using the GraphQL API

Note

The GraphQL API is currently available at the following endpoint:

https://graph.cleverbridge.com/graphql

If you are interested in using this API, contact Client Experience.

Before integrating our GraphQL API, read through the following information to help you get started:

Authentication

Important

Before you set up authentication for the cleverbridge GraphQL API, you MUST register with Client Experience. For more information about the registration process, see below.

The cleverbridge GraphQL API uses the open-source OpenID Connect framework for authentication. It allows cleverbridge to not only verify your identity using our identity server, but also obtain basic profile information which we then use to grant you an access token for the API.

OpenID Connect allows clients of all types, including web-based, mobile, and JavaScript clients, to request and receive access tokens. Therefore, you can set up authentication in a variety of ways. The following describes how to set up authentication for the cleverbridge GraphQL API and two types of clients that you can use to authenticate.

Header Values

The most relevant GraphQL request header values for our GraphQL API are the following:

Field Name Description Example
Values
Authorization Credentials that authenticate a user-agent with a server. Basic xxxxxxxxxxxxxxxxxxxxxx or Bearer Token
Content-Type Format of the request content. application/json

In the following example, the requested resource is a json object and the request type is a Bearer access token:

curl --location --request POST 'https://graph.cleverbridge.com/graphql' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjNmMWI0MTc1OGU0NzM3ZmI[...]'\
--header 'Content-Type: application/json' \
--data-raw '{"query":"query {        subscription(id: 23431030) {            id            extraParameters {                key                value            }        }}","variables":{}}'

Status Codes

The following describes the status codes that result from successful and unsuccessful calls to our GraphQL API.

Rate Limits

To guarantee a stable and reliable performance of our platform, cleverbridge places limits on the amount of data that can be consumed:

  • IP Rate Limit: Clients or users are limited to a maximum of 150 requests per second from an IPv4 address or IPv6/64 IP range. All API requests count towards the rate limit.

  • Rate Limit per Resource and Client: Some GraphQL resources only accept a certain number of requests from a client per time unit or in total. The limit is configured in the settings for the client.

Developer Guides

In the following guide, you can find additional information about the GRAPHQL API, including a list of available queries and mutations, as well as descriptions of how to implement particular use cases:

Reference Documentation

In the following reference documentation, you can find the GraphQL schema with definitions of object types and fields:

GraphiQL Explorer

GraphiQL is an in-browser tool for writing, validating, and testing GraphQL queries. To use GraphiQL, log in with your cleverbridge credentials: