Documentation
Rails Sandbox — a Rails-compatible API. Every page below is also available as raw markdown (append .md) and indexed in /llms.txt.
- Rails Sandbox — A Rails-compatible parts-procurement sandbox documented for humans and AI agents.
- Quickstart — Zero to a confirmed parts order in under five minutes, copy-paste curl.
- Authentication — Exchange a pre-registered client for an org-scoped api_key, then send it with Partly-Integration-ID on every call.
- Procurement lifecycle — From vehicle prep to a confirmed order — the state machine, plus the proposed extensions beyond it.
- Webhooks — Signed, at-least-once event delivery — and exactly how to verify the HMAC signature.
- Errors — Coded, type-tagged errors written to be read by LLMs and humans alike.
- Versioning & changelog — A date-versioned API (2026-01) carried in the URL path, plus a dated changelog of Rails Sandbox changes.
- For AI agents — How a coding agent should consume these docs and the companion Rails MCP.
- API Reference — Every 2026-01 wire method with request/response/error schemas and a runnable curl, plus the proposed extensions.