A RESTful API for your BoidCMS powered websites.

• Download the zip file of the plugin from this repo.
• Extract the contents of the zip file.
• Create a folder api in the plugins/ directory on your server.
• Copy the plugin.php file to the api folder.
• Follow the steps to activate and configure the plugin.

This plugin works on any version of BoidCMS.

The BoidCMS API is a powerful RESTful interface that allows programmatic access and management of your website's content, media, themes, and plugins.

All API requests must be prefixed with the base URL for version 1.

https://YOUR-DOMAIN.com/api/v1/

The API utilizes two separate, secret API Tokens for different access levels. These tokens are configured in the API Plugin Settings within the BoidCMS Admin Panel.

Tokens must be passed as Query Parameters (for GET and DELETE) or in the Request Body (for POST and PUT).

• Read-Only Example: GET https://YOUR-DOMAIN.com/api/v1/pages?token=YOUR_READ_ONLY_TOKEN
• Write-Access Example (Body):

  {
    "token": "YOUR_READ_ONLY_TOKEN",
    "auth": "YOUR_WRITE_ACCESS_TOKEN",
    "data": { ... }
  }

The API enforces a configurable rate limit (default 10 requests per minute). If exceeded, a 429 Too Many Requests status code is returned with a Retry-After header.

All endpoints return a JSON object with the structure: {"code": 200, "status": true, "message": "...", "data": { ... }}.

Manage and retrieve content pages.

Manage files in the media directory.

• Pagination: Use limit (max items, default 20) and offset (starting index, default 0) query parameters on list endpoints.
• Field Selection: Use fields[] query parameter to select specific fields to include in the response (e.g., fields[]=title).