Introduction

GraphQL

The Voxel API is organised around GraphQL. Ymage chose GraphQL for our Voxel API because it offers significantly more flexibility for our integrators. GraphQL provides a complete and understandable description of the data in our API, gives you the power to ask for exactly what you need and nothing more, makes it easier to evolve APIs over time, and enables powerful developer tools.

Authentication

To authenticate with the GraphQL api, you need an API access token. This token can be requested by contacting support@ymage.com. Keep this token in a safe place. This token can be used as a bearer token for authenticating with the Voxel API.

Testing

To test out the API we recommend using GraphiQL or another standalone client (e.g., Postman or Insomnia)

Dates and times

All date/time arguments need to be in ISO 8601 format. Fields containing date/time will always be in ISO 8601 format.

• Calendar dates: YYYY-MM-DD (e.g., 2021-03-17T09)
• Date and time: YYYY-MM-DDThh:mm:ssZ (e.g., 2021-03-17T09:20:28.994Z)