API Documentation Conventions
Understand how these API documents label published endpoints, workflow guidance, examples, roles, scopes, and response formats.
This documentation uses strict labels so developers can distinguish published behavior from workflow guidance. That distinction is important because PanelConfig is being documented as a production control panel, not as a vague product concept.
Labels Used
| Label | Meaning |
|---|---|
| Available | A matching file exists under /api/v1/ in the deployed build. |
| Public | The endpoint does not call pc_api_auth_user(). |
| Bearer token required | The endpoint calls pc_api_auth_user(). |
| Admin-capable user required | The endpoint checks pc_user_is_admin(). |
| Workflow guidance | Workflow guidance for integrations and operational patterns around the endpoint family. |
Endpoint URLs
Examples use the current file-based route format such as /api/v1/domains.php. If route rewriting is added later, human-friendly paths may be introduced, but integrations should use the routes that exist in the deployed build.
Scope Wording
The database stores token scopes and the public API page displays scope labels. In this source snapshot, endpoint files do not call a central scope-enforcement helper. Therefore, scope tables in these docs are described as published or recommended scope labels unless the code later adds explicit scope checks.