website logo
Channel Docs
Merchant Docs
Navigate through spaces
Channel Docs
Merchant Docs
⌘K
👋Welcome to Violet's Docs
💡Concepts
🚀Quick Start
🍎Create a Violet Application
😀Postman + Login
🏬View Merchants
👗Interact with Catalogs
🛍️Place an Order
🌐API Reference
✋Help
📝Changelog
Docs powered by archbee 
3min

Postman + Login

This section takes you through using Postman to test the Violet APIs. Make sure you have already signed up at channel.violet.io/signup and created an application in the step prior. If you haven't, please go through Create a Violet Application

The Violet Postman Collection is available here:  Violet Postman Collection

If you would like to fork the collection into your Postman workspace, you can do so here: Fork Violet Postman Collection

You will need your App ID and App Secret in order to complete this step.

Login

This API tests your connection to Violet by logging into your Application. Add X-Violet-App-Id and X-Violet-App-Secret added to your headers for login. These are available from the application you created on channel.violet.io. Every request after login will require these header params for authentication, along with the X-Violet-Token that you get from login and refreshing your token.

In addition to the headers mentioned above, include your username (your username is the email you signed up with) and password. If successful, an access token will be returned in the response body for use in additional requests against the API along with information about your API.

Get a cake by its ID
GET
Params
Body Parameters
id
required
String
ID of the cake to get

If you are using our Postman collection, you can add X-Violet-App-Id and X-Violet-App-Secret in the environment variables.

Refresh your Token

Use the Refersh Token to get a new token. This is an operation you will have to do on a regular basis. You can use your App Id and App Secret with a refresh token to get a new token. This saves the step of having to send your username and password each time to get a new token.



Updated 20 Dec 2022
Did this page help you?
Yes
No
UP NEXT
View Merchants
Docs powered by archbee 
Login