Rankbox
Docs

REST API

Pull finished articles into any CMS and report where they went live.

  1. 1API overviewThe Rankbox REST API lets your site pull finished articles and report where each one went live. Base URL, conventions, endpoints and a first request.
  2. 2Authentication and API keysHow Rankbox API keys work: the rv_live_ format, one key per site, creating, replacing and revoking keys, the Authorization header, and storing keys safely.
  3. 3Articles endpointsReference for GET /articles, GET /articles/{id} and PATCH /articles/{id}, with every parameter, the Article object, full examples and status codes.
  4. 4Ping endpointGET /ping checks a Rankbox API key and returns the brand, website and logo of the site it belongs to. Call it when someone connects your integration.
  5. 5Syncing articles reliablyPatterns for keeping a site in step with Rankbox: cursor paging with next_since, catch-up, full walks for deletions, content hashes, stable slugs and retries.
  6. 6ErrorsEvery error the Rankbox REST API returns: the JSON error format, each status code and its exact message, the causes, and how your integration should respond.
  7. 7Rate limitsThe Rankbox API's request limits: 300 per IP address and 120 per account in each one-minute window, what counts, the 429 response, and how to stay under them.
  8. 8TypeScript client and plugin starterThe TypeScript client behind Rankbox's own Framer plugin: methods, errors, retry rules, a copy for your project, and the plugin starter it builds on.
  9. 9Build a CMS integrationA step-by-step guide to a production Rankbox integration for any CMS: connect with ping, sync, map fields, protect CMS edits, report live URLs, handle deletes.