REST API Overview

Base URL#

All REST endpoints live under a version segment:

GET /api/help/v1/versions HTTP/1.1
Host: rikaiso.example
Accept: application/json

The help content that you are reading is itself available through a documented API. The full reference, including request and response examples, is published at /support/api and as an OpenAPI 3.1 document.

Authentication#

Read endpoints for published content are anonymous. Write endpoints require a bearer key issued by an administrator:

Authorization: Bearer rk_help_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Keys are stored hashed. A lost key cannot be recovered, only revoked and replaced.

Errors#

Errors use a single shape so clients can branch on code rather than on prose:

{ "error": { "code": "not_found", "message": "Unknown version" } }

Versioning#

Additive changes ship in place. Field removals and semantic changes ship as v2. Deprecated fields are documented for at least two releases before removal.