API Overview

The Oplix REST API provides programmatic access to all feedback collection, analysis, and management features. Built with modern standards, our API is designed to be intuitive, reliable, and scalable.

Base URL

All API requests should be made to:

https://api.oplix.com/v1

Authentication

All API requests require authentication using your API key. Include your API key in the Authorization header:

Authorization: Bearer your-api-key-here

Request Format

The API accepts JSON-formatted requests. Always include the Content-Type header:

Content-Type: application/json

Response Format

All responses are returned in JSON format with the following structure:

{
  "success": true,
  "data": {
    // Response data here
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "version": "1.0"
  }
}

Error Handling

Errors are returned with appropriate HTTP status codes and detailed error messages:

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request body is missing required fields",
    "details": {
      "missing_fields": ["title", "description"]
    }
  }
}

Rate Limiting

API requests are limited to:

  • 1000 requests per hour for free accounts
  • 10,000 requests per hour for paid accounts
  • 100,000 requests per hour for enterprise accounts

Rate limit headers are included in all responses:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1642176000

Pagination

List endpoints support pagination using cursor-based pagination:

GET /feedback?limit=50&cursor=eyJpZCI6IjEyMzQ1NiJ9

Webhooks

Set up webhooks to receive real-time notifications about feedback events. See our Webhooks documentation for details.

SDKs

Official SDKs are available for popular platforms:

  • JavaScript/TypeScript: @oplix/js-sdk
  • Unity: Unity Package Manager
  • Unreal Engine: Unreal Marketplace
  • Python: oplix-python
  • Go: github.com/oplix/go-sdk

Next Steps