The VineSpring API allows you to connect to VineSpring from other systems, facilitating integrations and making projects like highly-customized online storefronts a possibility. With the VineSpring API, you can easily share data across applications. This article will help you get set up and show you the basics of the API.
Table of Contents
- Important details
- Create a new API key
- Use your API key to make a request
- The VineSpring API is organized around REST.
- The API returns JSON-encoded responses, and uses standard HTTP response codes and verbs.
- API keys are used to authenticate requests.
- All requests must be made over HTTPS.
Create a new API key
Navigate to Settings->API Keys to view existing API Keys and to create new ones. To create a new one, use the Create New action.
New API Key
Name: enter a name for your API Key.
Enabled: Can be used to enable or disable your API Key.
After you save, click on your API Key to see the key itself.
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
Use your API key to make a request
To make a request, add a header named x-api-key with the value of your API key. For example, using cURL:
curl -X GET \
-H 'x-api-key: 5aW7meKD3ZSUurIw60j6jruskfbr0jqeyYYJ8RdT_599073b4ca65df0001a72c05'