RenewCMS/docs/design/screens/integration.md

Integration (API reference) and API keys

Routes: /integration and /integration/api-keys. Boards: RenewCMS Screens Back-office.dc.html (group "Integration") and RenewCMS Screens API keys.dc.html. Components: IntegrationPage.dc.html, ApiKeysPage.dc.html, mounted by AppFrame.

Navigation decision

Sticky section index on the right (desktop), "Jump to" select (mobile). A reference is read in one scroll and searched with the browser, so tabs would hide content and break find-in-page and deep links; the index keeps one page with anchors and shows position.

Page copy

• Header: breadcrumb "Integration", title "API reference", description "Everything a developer needs to build on RenewCMS."
• Intro: "RenewCMS is headless: it stores your content and your own code displays it. There are two ways in. Public read-only access lets a website read online articles. API keys let a script or service manage articles, media and users without the back-office."
• Base URL: label "Base URL", button "Copy" / "Copied" (2 s, announced).
• Authentication, card "Public": "No key needed. Two read-only routes, and only online articles are returned." GET /v1/article/, GET /v1/article/{id}.
• Card "API key": "Send Authorization: Bearer rcms_…. Requests act as the user who created the key, with that user's role (owner or admin). A key never has more rights than its creator." CodeBlock tabs curl, fetch (GET /v1/auth/me). "Keys start with rcms_ and are shown in full once, when you create them." Link "Manage API keys".
• Note 1: "A key can't create, list or revoke API keys, log in, register, verify or reset a password, or call anything under /v1/system. Those routes answer 403 "This action needs a real session." An invalid, unknown, expired or revoked key answers 401, even on public routes, and so does a key whose user was deleted or unverified."
• Note 2: "Each key can make 120 requests per minute. Beyond that the API answers 429 with a Retry-After header."
• Groups: Articles (7), Media (6), Users and invites (6), Settings (1), Session only (12 routes, 3 sub-groups). Session-only banner: "These routes need a signed-in browser session. With an API key they answer 403 "This action needs a real session.""
• Errors: table 400, 401, 403, 404, 409, 422, 429, 500 plus the JSON body.
• Notes: image URL prefix, CORS (existing copy), and "Article routes accept ?format=html or ?format=markdown to choose how body is returned."

EndpointCard states

• Collapsed (44 px row): method badge, mono path, one-line description, chips, chevron. Desktop is one line; mobile is three (method and path, description, chips).
• Expanded: "Request body" table (Name, Type, Required, Rule; "No request body." when empty), tabs fetch / curl / Response with one CodeBlock and Copy, then "Errors": status chip plus one-line caption (also its title tooltip).
• Session only: dashed border, muted fill, lock icon, "Session only" chip, no method colour, no expand.
• Chips: access "Public", "Verified user", "Owner only"; key "API key OK" (success soft) or "Session only" (dashed, muted).
• Method badges: GET --ui-bg-inverted, POST success soft, PATCH warning soft, DELETE error soft. Existing tokens only.

Board states (desktop 1440×900, mobile 390×844, light and dark)

1 Default · 2 Media group, POST /v1/media/ expanded with curl tab · 3a Base URL copied · 3b CodeBlock copied · 4 Authentication · 5 Session only · 6 Errors · 7 Navigation (index active item Media; mobile select open).

API keys screen

Placement: under Integration (sub-page), because keys exist to call the API and admins can create them; Settings is owner-only today. Session only.

• Columns: Name, Key (prefix, mono), Status (active, expired, revoked), Created by (owners only), Created, Last used, Expires, Revoke. Owners see all keys; admins see their own.
• Create key modal: Name (required, up to 60, counter), Expiry date (optional, must be in the future). Errors: "Enter a name." / "Use 60 characters or fewer." / "Choose a date in the future."
• One-time reveal: warning "You won't be able to see this key again.", monospace key, Copy / Copied, "Closing this window discards the key from the screen. Copy it first." Button "Done".
• Revoke: "Revoke this key?" / ""Nightly media import" (rcms_Mq7b…) will stop working right away. Requests that use it answer 401. This can't be undone." Buttons "Keep key", "Revoke key". Toast "Key revoked".
• Empty: "No API keys yet" / "Create a key to call the API from a script or service." Error: "Couldn't load your API keys" / "Check your connection and try again."
• Note: "Resetting a user's password revokes all of their keys."

Component inventory and Nuxt UI v4

• EndpointCard (extended): UCollapsible (trigger is a button with aria-expanded), UBadge (method, chips, status), UTable (body fields), UTabs (fetch, curl, Response), CodeBlock.
• SectionIndex (new): custom <nav> of anchor buttons with aria-current; sticky, scroll-spy. Mobile: USelectMenu labelled "Jump to".
• SessionOnlyGroup (new): UAlert-style info note plus list rows; no new colour.
• ErrorTable: UTable. Info notes: existing note style (or UAlert variant naked).
• API keys: UTable, UBadge, UModal with UForm/UFormField/UInput (type date), UAlert color warning, UButton, useClipboard.

Assumptions to confirm

Paths not in the brief: /v1/settings, /v1/auth/api-key, /v1/system/update/*, POST /v1/auth/register|verify|logout; body fields content, keepId, mergeIds, displayName, name; error body shape { "statusCode", "message" }. Code samples use a simple keyword and string colouring.

Tokens

No new tokens. Foundations check: colours, radius (0) and spacing come from existing --ui-* and --rc-* values; every control has a 2 px primary focus ring; index, select and cards are keyboard operable. Open question: the board hard-codes a few pixel sizes, as the other screens do.