API Reference

API Overview

API Reference Guide

API Overview

Everything you need to know to get started with this feature.

API Overview

Access our REST API to build custom integrations and automate your business.

Base URL

https://api.ds.vai.me/v1

Authentication

All API requests require authentication using API keys.

curl https://api.ds.vai.me/v1/products \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Get your API key →

Available Endpoints

Products

GET    /products           # List all products
GET    /products/{id}      # Get product details
POST   /products           # Create product
PUT    /products/{id}      # Update product
DELETE /products/{id}      # Delete product

Orders

GET    /orders             # List all orders
GET    /orders/{id}        # Get order details
POST   /orders             # Create order
PUT    /orders/{id}        # Update order status

Stores

GET    /stores             # List your stores
GET    /stores/{id}        # Get store details
POST   /stores             # Create store
PUT    /stores/{id}        # Update store

Request Format

Headers:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Accept: application/json

Example Request:

const response = await fetch('https://api.ds.vai.me/v1/products', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer sk_live_...',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();

Response Format

Success Response:

{
  "success": true,
  "data": {
    "id": "prod_123",
    "name": "Awesome Product",
    "price": 29.99
  },
  "meta": {
    "timestamp": "2025-10-12T10:30:00Z"
  }
}

Error Response:

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Product not found"
  }
}

Rate Limits

Standard: 1,000 requests/hour Enterprise: 10,000 requests/hour

Rate limit headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 995
X-RateLimit-Reset: 1634567890

Pagination

Large result sets are paginated:

GET /products?page=2&per_page=50

Response includes:

{
  "data": [...],
  "pagination": {
    "current_page": 2,
    "total_pages": 10,
    "per_page": 50,
    "total_items": 487
  }
}

Webhooks

Receive real-time notifications:

Available Events:

  • order.created
  • order.fulfilled
  • order.cancelled
  • product.created
  • product.updated

Configure Webhooks →

Error Codes

Code Description
200 Success
201 Created
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
429 Too Many Requests
500 Server Error

SDKs & Libraries

Official SDKs:

  • JavaScript/Node.js
  • Python
  • PHP
  • Ruby

Coming Soon:

  • Go
  • Java
  • .NET

View SDK Documentation →

Testing

Use test API keys for development:

Test Key: sk_test_...
Live Key: sk_live_...

Test keys don't process real transactions.

Need Help?


API Version: v1 (stable)

Was this helpful?

Still need help?

Contact Support