# RoamWorks Partner API

> Developer documentation for the RoamWorks local-eSIM partner API, including HMAC authentication, catalogue, quotes, wallet orders, redemption, webhooks and agent controls.

Use these docs when integrating with or operating a RoamWorks partner integration. Start with Overview and Quickstart, then Authentication, Limits and quotas, and Errors. Read the raw API Markdown for the compact reference and the agent prompt before delegating calls to an autonomous agent. The published OpenAPI document is at /openapi/v1.json.

## Documentation

- [Webhooks](/docs/webhooks.md): Receive signed order and redemption events, verify the HMAC, and handle retries.
- [Wallet](/docs/wallet.md): Read multi-currency balances, understand posted and available credit, and fund a partner wallet.
- [Quotes](/docs/quotes.md): Bind offers, quantities and currency to a 15-minute RoamWorks quote before payment.
- [Quickstart](/docs/quickstart.md): Create a sandbox key, sign an HMAC request, and complete a catalogue to redemption flow.
- [Prompt](/docs/prompt.md): A ready-to-paste system prompt for a RoamWorks purchasing agent, with budget, approval and recovery rules.
- [Overview](/docs/overview.md): What the RoamWorks Partner API does, what is live today, and where to start.
- [Orders](/docs/orders.md): Create wallet-funded purchases with quote-based or one-call ordering, then poll and redeem.
- [MCP](/docs/mcp.md): Status of the planned RoamWorks Model Context Protocol server and the safety rules for agent tools.
- [Limits and quotas](/docs/limits-and-quotas.md): Understand RoamWorks per-minute limits, account aggregates, daily quotas and retry behaviour.
- [IP allowlist](/docs/ip-allowlist.md): Restrict a RoamWorks API key to specific IPv4 or IPv6 addresses and CIDR ranges.
- [Errors](/docs/errors.md): Error envelope, request IDs, retry rules and the complete RoamWorks v1 error code table.
- [Environments](/docs/environments.md): Production and sandbox hosts, separate accounts, keys and data.
- [Catalogue](/docs/catalogue.md): Read eligible local eSIM offers, prices, availability and opaque offer identifiers.
- [Authentication](/docs/authentication.md): Sign RoamWorks v1 requests with an API ID, HMAC-SHA256 secret, timestamp and nonce.
- [Approval flow](/docs/approval-flow.md): How human approval is intended to work for agent orders above threshold, and what to do today.
- [Agent payment](/docs/agent-payment.md): How a scoped agent pays from a partner wallet, checks its mandate, and recovers from 402 and 429.
- [Agent identities](/docs/agent-identities.md): Issue scoped agent credentials, set budgets and expiry, and manage the agent lifecycle.