Setup

TIP

You need to setup a Vendor Auto account and add an Instance before using this API.

Create a Client App.

1. From the top right cornner of our page, click the user avatar, then go to Client Apps page.
2. Create a new client app.

Once you create a Client App, you will get a App ID and App Secret.

Authentication

An Api Key is required in the headers with name x-api-key of the requests to our API.

You can get the API key from http://vendoruto-20200328224306-hostingbucket-devb.s3-website-us-east-1.amazonaws.com/public-api-key.json.

Example
{
    // development
    "devb":{
       "key":"<Check with support for the key>",
       "expiration_date": "2022-06-23T06:52:41Z",
       "endpoint": "https://xxxxxxx.appsync-api.us-east-1.amazonaws.com/graphql",
    },
    // production...
}

TIP

You should consider to fetch the key dynamically by comparing the expiration_date.

You will also need to provide a credentials(appId and appSecret) object if needed.

Graphql

We offer our API through Graphql. To learn more about Graphql, please vitit https://graphql.org.

For Graphql Language Support

You could use Postman to test our API.