Seller API Collections
When developing against the Seller API, you can use a number of different API Test clients to make your life easier, for example:
We have created API collections for both Postman and Insomnia, which can be downloaded below.
- Download the Postman Collection for the Operator API here.
- Download the Insomnia Collection for the Operator API here.
Postman Setup VideoIf you prefer video to the written word we have step by step setup instructions for Postman here.
To import into Postman, download the
.json file and go to the import menu in Postman:
.json file you downloaded and confirm that you wish to import it:
Edit the collection to fill in the variables required to access your site (see the Postman documentation for more information)):
You will now see a series of requests in Postman which you can study and execute:
Insomnia is an alternative API client that can be used to run GraphQL queries and mutations in much the same way as Postman. Insomnia is particularly good at working with GraphQL as it ingests the GraphQL schema, enabling it to provide tool-tips, auto-code completion and present the in-line API documentation. Our Insomnia Collection can be downloaded here
Insomnia Setup VideoIf you prefer video to the written word we have step by step setup instructions for Insomnia here.
To import, click the “Create” button on the Insomnia Dashboard, and select “(Import From) File”:
Select the Marketplacer GraphQL API.insomnia_collection.json file you downloaded in the previous step, and click ok. You should see the confirmation once the file has imported:
Select the “Marketplacer Collection”
We now need to configure the base environment to:
- Point to your Marketplacer GraphQL API endpoint
- Use a your API Key
- [Optional] Configure credentials to connect to a staging environment
To do so, click the Environment drop down, then select Manage Environments:
As a minimum, you’ll need to provide values for:
If you’re using a staging environment, then you should provide values for:
An example of what your base environment config should look like is shown below (don’t forget to click “Done” after making any changes):
NoteThe configuration values used above are obviously just examples, you’ll need to plug in values relevant to your environment, obtaining these values are described here.
You should now be able to start using the Insomnia Collection.