Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.snappy.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Getting Started with the Snappy API

Welcome to the developer quickstart! This guide will help you authenticate and make your first successful API request in under 5 minutes.
Make sure you are using your Testing API key while building your integration. See Before You Begin for details on your two environments.

​
Step 1: Get Your API Key 

The Snappy API uses keys to authenticate requests. To ensure the highest level of security, Snappy uses Granular API Permissions, meaning you should only grant the exact permissions your application needs.
  1. Log in to your Snappy Dashboard https://login.snappy.com/login
  2. Navigate to Sharing & Access tab under the Company Settings page in the Snappy Dashboard.
  3. Scroll down to the ‘API Access’ section and enable API access for your organization (if not already enabled).
  4. Click ‘Create API Key’.
  5. Define the Scopes (e.g., Select ‘Read’ , ‘Create’ or ‘Update’ etc. based on our needs).
  6. Copy your new secret key. Note: For security reasons, you will only be able to see this key once.

​
Step 2: Authentication 

Snappy uses the X-Api-Key header to authenticate requests. You must include your API key in every request like so: 
X-Api-Key: YOUR_API_KEY
For example, using cURL: 
curl --request GET 
     --url https://api.snappy.com/public-api/v2/authentication/apiKeys 
     --header 'X-Api-Key: YOUR_API_KEY' 
     --header 'accept: application/json'
Keep your key secure. Never expose it in client-side code or public repositories. If a key is compromised, rotate it immediately from the Snappy Dashboard.

​
Step 3: Make Your First Request 

Test your connection by retrieving the API key you just created. The base URL for the Snappy API is https://api.snappy.com/public-api/v2. You can use the following cURL command in your terminal (just replace YOUR_API_KEY with your actual key): 
curl --request GET 
	--url https://api.snappy.com/public-api/v2/authentication/apiKeys 
	--header 'X-Api-Key: YOUR_API_KEY' 
	--header 'accept: application/json'
Expected Response (200 OK): If successful, you will receive a JSON payload containing the API key you generated in step 1: 
{
  "results": [
    {
      "id": "abc123456",
      "expirationDate": "2022-12-06T09:50:38.536Z",
      "createdAt": "2022-12-06T09:50:38.536Z",
      "enforceMtls": false,
      "name": "My API"
    }
  ]
}

​
Next Steps

Now that you have successfully authenticated, you can start building out your integration. Choose the flow that matches your use case: Triggered Gifting Send a gift invitation and let the recipient choose their own item: Direct Fulfillment Display the catalog in your own platform and place orders directly:
  • Retrieve the product catalog and browse available products and variants to display in your UI using. See Get products.
Last modified on April 30, 2026