# REST API

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

- [API overview](https://rankbox.xyz/docs/api/overview.md): The Rankbox REST API lets your site pull finished articles and report where each one went live. Base URL, conventions, endpoints and a first request.
- [Authentication and API keys](https://rankbox.xyz/docs/api/authentication.md): How Rankbox API keys work: the rv_live_ format, one key per site, creating, replacing and revoking keys, the Authorization header, and storing keys safely.
- [Articles endpoints](https://rankbox.xyz/docs/api/articles.md): Reference for GET /articles, GET /articles/{id} and PATCH /articles/{id}, with every parameter, the Article object, full examples and status codes.
- [Ping endpoint](https://rankbox.xyz/docs/api/ping.md): GET /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.
- [Syncing articles reliably](https://rankbox.xyz/docs/api/syncing.md): Patterns 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.
- [Errors](https://rankbox.xyz/docs/api/errors.md): Every 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.
- [Rate limits](https://rankbox.xyz/docs/api/rate-limits.md): The 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.
- [TypeScript client and plugin starter](https://rankbox.xyz/docs/api/client-library.md): The TypeScript client behind Rankbox's own Framer plugin: methods, errors, retry rules, a copy for your project, and the plugin starter it builds on.
- [Build a CMS integration](https://rankbox.xyz/docs/api/build-an-integration.md): A 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.
