Learn about our new Popup Order Process and the steps to integrate the process with your online checkoutRead the Guide
Home >

GraphQL API

Note

The GraphQL API is currently available at the following endpoint:

https://graph.cleverbridge.com/graphql

Until now, only a limited number of our clients have integrated its resources. 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 backend stability — GraphQL isn't tied to any specific database or storage engine but is based on existing code and data.

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 what 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.

Example

GraphiQL Explorer

To try out the cleverbridge GraphQL API, go to our GraphiQL Explorer. Here you will find an in-browser tool for writing, validating, and testing GraphQL queries. Simply type queries into the left side of the screen, and you will see intelligent typeaheads aware of the current GraphQL type schema. There are also live syntax and validation errors highlighted within the text.

GraphQL API Reference

For an overview of our current GraphQL schema, which includes a description of all available queries, mutations, and objects, go to our GraphQL API Reference.