WebPlayz

§ Reference · v1

The API

Integrate the catalogue into your platform. Authenticate with an API key, respect the rate limits, and query the endpoints below.

No. 01

Authentication

To access the API, provide a valid API key in the Authorization header of your requests.

Authorization: Bearer YOUR_API_KEY

Note. You can generate your API key from your dashboard.

No. 02

Rate limits

To ensure service stability, the API is rate-limited per key.

  • Limit: 60 requests per minute, per API key.
  • Headers: responses include X-RateLimit-Limit and X-RateLimit-Remaining.
  • Exceeded: returns 429 Too Many Requests.

No. 03 · Endpoint

List games

GET /api/v1/games

Retrieve a paginated list of available games.

Query parameters

Name Type Description
page integer Page number for pagination (default: 1).

Example response

{
    "current_page": 1,
    "data": [
        {
            "id": 1,
            "title": "Space Adventure",
            "slug": "space-adventure",
            "description": "Explore the galaxy in this thrilling adventure.",
            "thumbnail_url": "https://example.com/thumb.jpg",
            "play_url": "https://example.com/play/space-adventure",
            "categories": [...]
        }
    ],
    "first_page_url": "...",
    "from": 1,
    "last_page": 10,
    "last_page_url": "...",
    "links": [...],
    "next_page_url": "...",
    "path": "...",
    "per_page": 20,
    "prev_page_url": null,
    "to": 20,
    "total": 200
}

No. 04 · Endpoint

Single game

GET /api/v1/games/{id}

Retrieve details for a specific game by ID.

Example response

{
    "id": 1,
    "title": "Space Adventure",
    "slug": "space-adventure",
    "description": "Explore the galaxy in this thrilling adventure.",
    "thumbnail_url": "https://example.com/thumb.jpg",
    "play_url": "https://example.com/play/space-adventure",
    "orientation": "landscape",
    "categories": [
        {
            "id": 5,
            "name": "Action",
            "slug": "action"
        }
    ]
}