Passive Marketplace or White-label App Platform Integration Module

Introduction

Connect your marketplace or restaurant white-label app to OpenQloud (asking OpenQloud to consume your APIs and throwing webhooks to OpenQloud)

Passive integration

Passive Integration Only

This guide is ONLY for passive integrations, understood as integrations in which OpenQloud will consume your API services and listen your webhooks. If you don't have your own API and webhook notifications and you are not planning to develop them, please go to market active integration docs.

Integration level

In OpenQloud we have different integration module types. For a market integration module, we have different module features in order to help the restaurant to understand the benefits of contracting the module. All features are optional and defined by the limits of the company developing the integration and the company providing API or services webhook.

Integration requirements

For a full integration, we would need all these API services and webhooks:

API SERVICES

GET Order / Reservation

Service/s to get an order or reservation information of a previously received order

GET Order / Reservation Status

Service/s to get an order or reservation status of a previously received order

POST/PATCH Menus, products, variants, options

Service/s to create or modify the entities defining the "online catalog" of the restaurant

POST/PATCH Order / Reservation Status

Service/s to change the status of a previously received order or reservation

POST/PATCH Delivery Location

Service/s to inform the current driver's location (for you to show it to your customer)

POST/PATCH Restaurant Availability

Service/s to change the restaurant's availability in your market (schedules, shifts, calendar exceptions, ...)

WEBHOOK NOTIFICATIONS

The webhook notifications are POST/PUT requests thrown by your system to a specific endpoint we provide.

New order / reservation

Notification you send for a new order or reservation

Order / reservation status changed

Notification you send for an order or reservation status change from your side

Webhook Endpoint

We will provide an endpoint to receive your notifications. Example: https://integrations.openqloud.com/{your-market-code}/webhooks/{any-other-data}

OTHER REQUIREMENTS

API and webhooks docs - Document or whatever you normally use to document your API for third-party developers
Restaurant test account - An account to test and ideally access to the restaurant's dashboard
Sandbox and production credentials - API keys or equivalent for production environment, and ideally, for sandbox/test environments

Data model

As this integration is passive, we adapt our data to your data model (to consume API services and understand the webhooks). In order to show you examples of these entities, we invite you to check the market active integration docs.

Integration request

If you already have your API and webhooks docs and you want OpenQloud to develop the integration module, please send us an email to integrations@openqloud.com

We'll provide a document explaining which features have been integrated and which ones were not integrated and the reasons, and of course, we'll attend any validation session if it's considered in your workflow.