Overview
The RestroLab Third-Party Integration API lets an external platform (food delivery, booking/OTA, POS, marketplace, and so on) connect to an organization’s Restaurant and/or Hotel operations in RestroLab. Your platform reads the organization’s menu or rooms, places orders and reservations on their behalf, and gets notified as those orders and reservations change.
Who’s involved
Section titled “Who’s involved”| Role | What they do |
|---|---|
| Organization owner (the restaurant or hotel, also called the tenant) | Uses RestroLab to run their business. Creates an integration credential in their RestroLab dashboard and gives it to you once. |
| Your platform | Calls this API from your own backend using that credential. Your platform never logs into RestroLab directly. |
How it works
Section titled “How it works”- One credential per organization. Each credential is a
Restro-API-Key/Restro-API-Secretpair, sent as headers on every request. See Authentication. - The credential decides the tenant. There’s one shared API host for every organization. You never send a
tenant_id,restaurant_id, orhotel_id; RestroLab works out the organization from the credential. - Modules are independent. The same credential covers both modules, but each one only responds if the organization has enabled it. Calling a module that isn’t enabled returns
403. See Feature gating. - Your IDs, not ours. You create orders and reservations with your own
external_order_id/external_reservation_id, and use those same IDs to fetch, update, or cancel them later.
What you can do
Section titled “What you can do”Restaurant (Restro module)
Section titled “Restaurant (Restro module)”- List the organization’s active dishes, with prices, variants, and add-ons.
- Place orders using each dish’s
skuas theitem_id. - Look up, list, and cancel orders you’ve placed.
- Report how an unpaid order was settled (cash, card, and so on).
Hotel module
Section titled “Hotel module”- List room types and check availability for a date range.
- Create reservations, optionally recording what the guest already paid.
- Look up, list, and cancel reservations you’ve placed.
- Change a reservation’s check-in or check-out dates.
Shared
Section titled “Shared”- Check that a credential works with
GET /v1/restrolab/ping/. - Register one webhook URL to receive order and reservation events for both modules.
A typical integration
Section titled “A typical integration”Restaurant:
- Fetch the menu with
GET /v1/restro/dishes/. - When a customer checks out on your platform, place the order with
POST /v1/restro/orders/, using your ownexternal_order_id. - Receive
order.status_changedwebhooks as the restaurant prepares and completes the order.
Hotel:
- Fetch room types with
GET /v1/hotels/roomtypes/. - Check availability with
GET /v1/hotels/roomtypes/{room_type_id}/availability/. - Create the reservation with
POST /v1/hotels/bookings/, using your ownexternal_reservation_id. - Receive
reservation.*webhooks when the reservation is confirmed, modified, or cancelled.
Things to know up front
Section titled “Things to know up front”| Topic | In short |
|---|---|
| Idempotency | Retrying a create with the same external ID returns the existing order or reservation (200 OK) instead of making a duplicate. |
| Webhooks | HMAC-SHA256 signed, HTTPS only, retried up to 5 times. Keep polling as a fallback. |
| Rate limits | 300 requests per minute per credential, shared across the whole API. |
| Pagination | Most lists return every record in one array. Room types are the exception. |
| Errors | Every error has a machine-readable code and a human-readable message. Match on code. |
Next steps
Section titled “Next steps”- Quickstart: get your credential working and make your first call.
- Your First Request: a full walkthrough of listing the menu.
- API Reference: every endpoint, parameter, and schema, with live requests.
