Developer Documentation
Requiply's public API lets your own website, app, or back-office tool read the catalog, check availability, price quotes, take booking requests, and work with bookings, clients, sales, and reports.
Ways to integrate
| Option | Best for |
|---|---|
TypeScript SDK (@requiply/api-sdk) | JavaScript and TypeScript apps: Next.js, Nuxt, Node.js, serverless functions, and browsers. Typed inputs and responses, query serialization, and RequiplyError. |
| REST API | Any other language or runtime. JSON over HTTPS below https://api.requiply.com/api/public/v1. |
| MCP server | AI agents that should work with the organization's data through tools instead of HTTP calls. |
The SDK is the recommended path for JavaScript. These guides cover SDK version 0.2.0, which supports Node.js 18 or later and modern browsers with fetch. Dedicated @requiply/next and @requiply/nuxt packages are planned but not available yet.
Start here
- Create an API key and choose publishable or secret.
- Install the SDK.
- Follow the Quick Start for a first server call and a storefront booking request.
- Look up each method in the SDK resource guides, or each endpoint in the REST API Reference.
- Copy a pattern from Examples.
What a storefront can do with a publishable key
- Show the organization's name, logo, working hours, delivery options, and payment methods.
- List categories, products, and services, with availability for chosen dates.
- Price an exact quote with the pricing tiers and services applied.
- Send a booking request that staff approve in the app.
- Offer goods for sale with the booking, when the organization sells to customers.
Everything else, including clients, bookings, sales, and reports, needs a secret key on a server.
Package links
AI usage
Track how many AI credits your plan includes, see what has been used, and buy more credits for the assistant, template drafting, bundle photos, the web widget, and the portal chat.
Authentication and API Keys
Create, name, and revoke Requiply API keys, choose between a publishable key for browser storefronts and a secret key for servers, and learn the rate limit.