Getting Started with Joisu API

How to Access the API Documentation

Use the sidebar to navigate between API domains. Each domain has its own comprehensive documentation powered by ReDoc. Click a domain to view its endpoints, schemas, and usage examples.

Standard API Response Format

{
  "success": true,
  "data": { /* ... */ },
  "error": null
}
{
  "success": false,
  "data": null,
  "error": {
    "type": "ValidationError",
    "detail": "Missing required field: email"
  }
}

All responses follow this structure. On error, success is false and error contains details.

Authentication

All endpoints require authentication via an API key. Include your API key in the Authorization header as follows:

Authorization: Bearer <your-api-key>

You can obtain your API key from your developer dashboard. Never share your API key publicly.

Quick Start Guide

  1. Choose the API domain you want to work with using the sidebar.
  2. Review the API documentation for endpoints, schemas, and examples.
  3. Obtain your API credentials from your dashboard.
  4. Make your first API request using the provided examples.
  5. Check out our code samples and SDKs for popular programming languages.