GraphQL API Guide

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.

The cleverbridge GraphQL API is an alternative to the collection of REST APIs that we offer. By switching to the GraphQL API, you can take advantage of a number of its features, which include the following:

  • Better query efficiency — You can now access numerous resources from a single endpoint.
  • No unnecessary data — It is now possible to get exactly what you need in a compact, concise payload.
  • More stability — GraphQL isn't tied to any specific database or storage engine but is based on existing code and data.

At the moment, the GraphQL API can help you manage your customers, products and prices. As a result, you can use this API to renew customer license keys, resend customer emails, and update product descriptions, etc. After the integration, you can also use this tool to create customer self-service options and ensure that your internal product catalog is up-to-date.

To start using the API and learn more about its capabilities, see the following:

GraphQL vs. REST

The following examples illustrate some of the benefits of using our GraphQL API in comparison to the cleverbridge Pricing API. As demonstrated in the REST examples, the user not only has to call a specific endpoint to obtain product and pricing information, but the content of the payload is standard, large, and tied to the /prices resource.

Example

On the other hand, when using GraphQL, the user can call one single endpoint and precisely define which data the API should return. This results in a smaller, more manageable payload.

Example

If necessary, the user can also call an additional resource in the same request (for example, biBookmark). In REST, the user would have to make two separate calls to two independent endpoints.

List of Queries and Mutations

The following are the queries and mutations currently available using the GraphQL API:

GraphQL Use Cases

The cleverbridge GraphQL API is a powerful resource that you can use in various different ways. This page provides a list of common scenarios as well as code examples to help you integrate the API.