API & SDKs
Readme

API Reference

Status: โœ… Production Ready
Base URL: https://id.optare.one


๐Ÿ“š API Documentation

Products API

  • GET /v1/products - List all products
  • POST /v1/products - Create new product
  • GET /v1/products/{slug} - Get product details
  • PATCH /v1/products/{id} - Update product
  • DELETE /v1/products/{id} - Delete product

Subscriptions API

  • GET /v1/subscriptions - List all subscriptions
  • POST /v1/subscriptions - Create new subscription
  • GET /v1/subscriptions/{id} - Get subscription details
  • PATCH /v1/subscriptions/{id} - Update subscription
  • DELETE /v1/subscriptions/{id} - Cancel subscription

Organizations API

  • GET /v1/organizations - List organizations
  • POST /v1/organizations - Create organization
  • GET /v1/organizations/{id} - Get organization details
  • PATCH /v1/organizations/{id} - Update organization

Users API

  • GET /v1/users - List users
  • GET /v1/users/{id} - Get user details
  • PATCH /v1/users/{id} - Update user
  • DELETE /v1/users/{id} - Delete user

๐Ÿ” Authentication

All API requests require authentication using API keys or OAuth tokens.

API Key Authentication

Authorization: Bearer sk_live_xxxxx

OAuth Authentication

Authorization: Bearer <access_token>

๐Ÿ“– Detailed Documentation

For detailed API documentation, see:


๐Ÿš€ Quick Start

  1. Get API credentials from Admin Portal (opens in a new tab)
  2. Use the CLI tool for quick testing
  3. Use the SDK for application integration

๐Ÿ“ž Support

For API support:


Next: OAuth Integration or CLI Guide