GraphQL Playground

To test and try out different GraphQL queries on the VPD service, a graphical user interface is available. This interface is called 'Playground'.

The Playground has documentation for the party schema, and allows for easy auto-complete for keywords when writing a query.

Authentication

Because of the authentication requirement of the VPD service, a manual action is required to add a bearer token to the GraphQL requests. Details on how to acquire a bearer token are described in getting started

Once you have a token, it needs to be added as a header object in the Playground. In the top right corner is the settings menu. You can click on the cogwheel icon to open a new tab with the current configuration settings of the Playground.

Locate the section with the entry 'request.globalHeaders':

Replace the '<insert token>' part with your access token and then click on Save Settings in the top right corner. If you return to the first tab, labelled "Example" you should be able to press the Play button ▶️.