Getting Started

Introduction

The Pixelsuite API provides a powerful and flexible interface for interacting with the Pixelsuite platform. This documentation will guide you through authentication, available endpoints, and code examples to help you integrate with our services quickly and efficiently.

Quick Start

1. Obtain an API Key

To use the Pixelsuite API, you'll need an API key. Contact your account manager or system administrator to request API access. Each API key has specific permissions and rate limits assigned.

2. Make Your First Request

Test the API with a simple ping request (no authentication required):

curl -X GET https://api.pixelsuite.com.au/v1/ping

Expected response:

{
  "success": true,
  "message": "pong",
  "timestamp": 1708000000,
  "requestId": "req_abc123",
  "meta": {
    "statusCode": 200,
    "apiVersion": "1.0"
  }
}

3. Authenticate Your Requests

For protected endpoints, include your API key in the Authorization header:

curl -X GET https://api.pixelsuite.com.au/v1/client \
  -H "Authorization: Bearer YOUR_API_KEY"

Expected response:

{
  "success": true,
  "data": {
    "client": {
      "displayName": "Your Company Name",
      "timezone": "Australia/Sydney"
    },
    "venues": []
  }
}

4. Explore the Documentation

• Authentication — Learn about API key authentication
• API Endpoints — Browse all available endpoints and their parameters
• Code Examples — See real-world integration examples in multiple languages
• Security Guide — API key security and best practices

API Overview

Base URL

https://api.pixelsuite.com.au/v1

API Versioning

All API endpoints are versioned with the /v1 prefix. This ensures backward compatibility as the API evolves over time. Future versions will use /v2, /v3, etc.

Response Format

All API responses are returned in JSON format with a consistent structure:

{
  "success": true,
  "message": "Success",
  "timestamp": 1708000000,
  "requestId": "req_abc123",
  "meta": {
    "statusCode": 200,
    "apiVersion": "1.0"
  },
  "data": {}
}

Response Fields:

Rate Limiting

The API implements rate limiting to ensure fair usage and system stability. Each API key has a default limit of 1000 requests per hour. Rate limit information is included in response headers:

• X-RateLimit-Limit — Maximum requests allowed per hour
• X-RateLimit-Remaining — Requests remaining in current window
• X-RateLimit-Reset — Unix timestamp when the rate limit resets

When you exceed the rate limit, you'll receive a 429 Too Many Requests response:

{
  "success": false,
  "message": "Rate limit exceeded",
  "error": {
    "message": "You have exceeded the rate limit. Please try again later.",
    "code": 429
  },
  "meta": {
    "statusCode": 429,
    "retryAfter": 3600
  }
}

Error Handling

The API uses standard HTTP status codes to indicate success or failure:

Error Response Format:

{
  "success": false,
  "message": "Authentication Required",
  "error": {
    "message": "No API key provided in Authorization header",
    "code": 401,
    "field": null
  },
  "meta": {
    "statusCode": 401
  }
}

Next Steps

Ready to start integrating? Here are some helpful resources to continue your journey: