Skip to main content

index

The VO platform is based on a GraphQL API, facilitating seamless integration with custom applications.

We offer guidance and provide examples for the following development stacks:

If you're using a different development stack, our guides and examples can still serve as valuable references. The GraphQL API section provides further details on integrating with the API using your chosen development stack.

GraphQL API​

All data and operations are accessible through the API, which presents a strongly typed, documented and discoverable schema.

Apollo Sandbox UI​

Apollo Studio is a GraphQL IDE that enables you to explore the VO API. It's an ideal tool for delving into the schema, building and running queries, as well as referencing the documentation.

You will need to be onboarded as a platform user to access Apollo Studio and the API.

Access Apollo Sandbox at /graphql

Basic Apollo Studio usage​

  • Navigate the schema and select operations, types, and fields using the Documentation tab in the Explorer view.
  • Define operation variables through the Variables tab.
  • Utilize the Traces view to gauge the performance of your query.
  • Generate a link to an operation definition using the Share button.
  • Export data in JSON or CSV format.

Apollo Studio Basic

Apollo Studio Traces

Subscriptions in Apollo Studio​

Query and Mutation operations work out of the box through cookie authentication (see the Include cookies setting in Connection settings).

To use subscription connections, which do not include cookies, you need to provide an Authorization header for the subscription operation.

  1. Copy an Authorization header value from the Composer using your browser dev tools
  2. Insert the Authorization header into the Headers section in Apollo Studio

You can now subscribe to events and see event data. Typically, an access token is valid for approximately 50 minutes, subject to your tenant configuration.

Apollo Sandbox Subscriptions