Skip to main content
Snag API documentation overview showing authentication and endpoint details
Using an AI coding assistant? Connect Cursor, Claude, or Copilot to Snag Docs for context-aware help. Learn how.
Please only use the endpoints specified in this document. Using any other endpoints will cause issues with your client.

​
What You Need

Retrieve your API Key, Currency ID, and Organization ID from the admin dashboard.

​
Authentication

All API endpoints require authentication using an API key, which must be included in the request headers. Include your API key in the x-api-key header as shown below: 
x-api-key: <YOUR_API_KEY>

​
Base URL

For development and testing purposes, you can use the following base URL: 
https://admin.snagsolutions.io
The development base URL has rate limiting restrictions. For production environments, it’s recommended to configure a custom hostname to get better rate limits and improved performance.

​
Custom Hostname Configuration

You have two options for configuring your production API base URL:
Configure a subdomain on your own domain (e.g., api.yourwebsite.com or loyalty.yourwebsite.com):
  1. Choose your desired subdomain
  2. Add a CNAME record pointing to your Snag platform
  3. Configure the hostname in the admin dashboard

Learn more about custom domain setup

Detailed instructions for configuring CNAME records and hostname setup.
Both custom hostname options provide better rate limits and performance compared to the development base URL. Choose the option that best fits your branding and infrastructure requirements.

Rate Limits & Hostname Configuration

Learn about rate limits for different hostname configurations and best practices for avoiding rate limit issues.
Here’s an example of an HTTP request with the API key: 
GET /api/v1/your-endpoint HTTP/1.1
Host: api.snag.com
x-api-key: <YOUR_API_KEY>
Content-Type: application/json

{ /* Request body if applicable */ }

SDK Reference

TypeScript SDK for type-safe access to Snag APIs.

Rate Limits

Understand rate limiting and hostname-based limits.

Loyalty Overview

Configure reward programs and automate incentives.

User Authentication

Set up wallet, email, and social login for your platform.