API Documentation

Build custom integrations with Zently's RESTful API

Getting Started

The Zently API is a RESTful API that allows you to programmatically access and manage your store data. All API requests require authentication using an API key. 

# Base URL
https://app.zently.me/api/v1

# Authentication
Authorization: Bearer YOUR_API_KEY

Authentication

All API requests must include your API key in the Authorization header. You can generate API keys from your dashboard settings.

Python Example

import requests

api_key = "your_api_key_here"
headers = {
    "Authorization": f"Bearer {api_key}",
    "Content-Type": "application/json"
}

response = requests.get(
    "https://app.zently.me/api/v1/products",
    headers=headers
)

products = response.json()

Endpoints

Products

Manage your store products

  • GET /api/v1/products - List all products
  • POST /api/v1/products - Create a product
  • GET /api/v1/products/{id} - Get product details
  • PUT /api/v1/products/{id} - Update product
  • DELETE /api/v1/products/{id} - Delete product

Orders

Access order information

  • GET /api/v1/orders - List all orders
  • GET /api/v1/orders/{id} - Get order details
  • POST /api/v1/orders/{id}/refund - Process refund

Webhooks

Receive real-time notifications

  • order.created - New order placed
  • order.paid - Order payment completed
  • product.updated - Product modified

Rate Limits

API requests are limited to 1000 requests per hour per API key. Rate limit information is included in response headers.

Need Help?

For detailed API documentation, code examples, and SDKs, visit your dashboard or contact our support team.

Contact Support