This section provides a detailed roadmap for integrating with the Kitchenhub API — from setup to pilot launch.
Step 1: Set Up Test Environment
Goal: Prepare both sides to begin technical integration.
Estimated time: 1–3 business days
Expected result: API credentials are active, and the partner's environment is ready to receive test data.
Actions:
| Responsibility | Action |
|---|---|
| Kitchenhub | - Generate and share API credentials (client ID, secret) - Provide access to staging environment - Share API documentation and test instructions |
| Partner | - Set up development environment using test credentials - Configure webhook endpoint to receive order events - Confirm network/firewall rules allow communication |
✅ Once this step is completed, API calls can be made, and webhooks can be tested.
Step 2: Develop Integration
Goal: Build the core logic for communication with the Kitchenhub API.
Estimated time: 1–3 weeks, depending on complexity
Expected result: Functional integration in the test environment, supporting the selected scenario.
Actions:
The following API modules should be implemented based on your use case:
🔹 Orders API
- ✅ Receive new orders via webhook (
POST /orders) - ✅ Parse order payload (items, modifiers, pricing)
- ✅ Accept or reject incoming orders (
PATCH /orders/:id) - ✅ Retrieve historical orders (
GET /orders/history)
🔹 Locations & Stores API
- ✅ Create and manage restaurant/store entities (
POST /stores,PUT /stores/:id) - ✅ Edit store settings (timezone, address, etc.)
- ✅ Remove test locations when no longer needed
🔹 Integrations API
- ✅ Connect a store to a marketplace (
POST /integrations) - ✅ Check connection status (
GET /integrations/:id/status) - ✅ Disconnect integrations when necessary
🔹 Menu API (if applicable)
- ✅ Build menu structure (categories, items, modifiers)
- ✅ Upload menu to Kitchenhub (
POST /menus) - ✅ Update menu items and availability
- ✅ Optionally, import menu from existing provider
Kitchenhub team can assist in determining which APIs are required based on your integration scenario.
Step 3: Acceptance Testing
Goal: Verify that the integration meets technical and business requirements.
Estimated time: 2–5 business days
Expected result: All flows work as expected in the test environment and meet acceptance criteria.
Actions:
| Responsibility | Action |
|---|---|
| Kitchenhub | - Provide acceptance test checklist - Simulate order creation from various providers - Validate partner responses and system behavior |
| Partner | - Validate receipt and handling of test orders - Confirm synchronization of menus, stores, and status - Fix any discovered issues or edge cases |
📋 Acceptance Criteria typically include:
- Timely order webhook delivery
- Correct parsing and acknowledgment of orders
- Proper syncing of store/menu data
- Resilience to API errors or edge cases
Step 4: Pilot Launch
Goal: Test integration in production with a small number of live locations.
Estimated time: 1–2 weeks
Expected result: Stable operation under real-world conditions, readiness to scale.
Actions:
| Responsibility | Action |
|---|---|
| Kitchenhub | - Enable production credentials - Monitor live data flow - Provide logs, alerts, and integration support |
| Partner | - Launch in selected stores - Monitor order and menu flow - Report and fix issues collaboratively |
📌 Focus is on:
- Validating that live orders are processed correctly
- Monitoring webhooks and response times
- Ensuring store/menu sync is aligned with partner systems
What Happens After the Pilot?
- If successful, the partner can scale to additional stores.
- Kitchenhub provides ongoing support and advanced features (e.g., analytics, real-time alerts).
- Optional steps: production monitoring setup, SLA definition, or deeper integration with partner systems.
🛎️ Support & Resources
- 🧪 Test Data Generator: Available upon request