You receive an offer from an external service - an ordering platform, a QR menu, a reservations, loyalty or delivery app - and you wonder whether it can connect to Ebriza. Sometimes the provider themselves tells you that "it can be done". Below you will find how to check and what comes next.
First, check whether the integration already exists
The integrations you can install yourself are found in your account, in the Marketplace, in the Integrations category. If you find the service you are looking for there, the integration exists: you install it and follow that app's help article.
If you do not find it, write to us on chat before drawing a conclusion. Not all Ebriza apps appear in the Marketplace - some are included in the main packages, others are installed by the Ebriza team - so its absence from the list is not a definitive answer either way. We will confirm exactly how things stand for the service you use.
The fact that Ebriza has a public API does not mean we have an integration with every service
Ebriza has a public, documented API that any provider can use to build an integration. This means that an integration is technically possible - not that the integration with a specific service already exists. These are two different things, and the answer to "do you have an integration with X?" is given by the list of integrations, not by the existence of the API.
Who this guide is for?
This guide is written for the providers and developers who are building an integration with Ebriza on our public API.
If you are an Ebriza customer and you only want to find out whether a specific external service is already integrated with Ebriza, that is a different question, and the answer is not in this article. The fact that we have a public API does not mean we have an integration with every service. See the article "Can a specific external service be integrated with Ebriza?".
Keep in mind: a new integration with an external provider is set up separately, with each provider individually. It cannot be started from the account, neither by the customer nor by the provider, and there is no key in the Marketplace that activates it.
A new integration cannot be started from your account
There is no key in the Marketplace that you can take and use to activate an integration with a new provider by yourself. Neither you nor the provider can start a new integration from the account on your own. Each integration is set up separately, with each provider individually, and the Marketplace app is created by the Ebriza team after the integration has been agreed and tested.
In short, the steps are these:
1. You tell us which service you want to integrate, or the provider writes to us directly at dev@ebriza.com.
2. The provider builds the integration on our public API, using the public documentation.
3. The Ebriza team creates the app in the Marketplace, first on the test environment and then on the production one, after testing is complete.
4. You install the app in your account, and from there the integration works like any other.
We cannot promise you a deadline: it depends on the provider and on the complexity of the integration. What we can do straight away is register your request.
Cases that look the same, but are not:
- Your own online ordering website: there you do not need a new integration. You use the Web Orders app, which you install yourself from the Marketplace - see the article Integrate external providers with Ebriza"
".
- You have your own app or a developer who wants to connect to Ebriza: the documentation is public and you can read it right away - see the article "Integrate external providers with Ebriza" and the technical reference at https://ebriza.com/app/public/docs. For technical questions, dev@ebriza.com.
- The service already appears installed in your account, but you cannot see it: this is most likely a permissions problem, not an integration one - see the article I can't find an app in my account (even though it is installed)".
To use the Ebriza API you need to have an app in Ebriza Marketplace. The app represents an integration between your service (Website, Ordering app...) and the Ebriza platform, and is the only way you can authenticate your requests. The Ebriza client installs your app in their account, and this is how they give your service access to their data.
The Ebriza team will create the app for you, first on the stage environment and then on the live environment, after the testing phase is completed. To create the app we will need from you:
- App name: com.ebrizadev.<yourappname>
- App title
- App logo
- Stage callback URLs: ChangeStatusUrl, SyncProductsUrl, StartAcceptingOrdersUrl, SetItemUnavailableUrl
- Live callback URLs: ChangeStatusUrl, SyncProductsUrl, StartAcceptingOrdersUrl, SetItemUnavailableUrl
The Ebriza team will also provide you with a test account on the stage environment, with the new app installed for testing.
After the app is installed on stage you will find the API keys by navigating to your app in the left menu. By installing the app, a CLIENT ID is generated. The client id identifies the location (restaurant) from the account (an Ebriza account can have multiple locations). Below you can find a screenshot from an Ebriza account:
Push orders to Ebriza:
We offer a special endpoint where you can push the orders only by specifying the CLIENT ID (ebriza-clientid) and your app name (ebriza-appname) in the header.
TAGS: [integration with an external service, do you have an integration with, can it be integrated with Ebriza, how do I make a new integration, integration with a new provider, Ebriza public API, integration key from Marketplace, I cannot find the integration in the Marketplace, how do I connect an external app to Ebriza, ordering platform integration, QR menu integration, reservations app integration, loyalty app integration, delivery app integration, developer wants to connect to Ebriza, Ebriza API documentation, dev@ebriza.com, how long does a new integration take]