Welcome to the Ordatic Public API. Please read this documentation carefully before moving on to the API Reference.
First of all...
Access to Ordatic's Public API is currently not public. The first thing you will need to do is send an email to [email protected] and indicate:
- your name
- your email
- your phone number
- the reason why you request access to Ordatic's Public API
Access Credentials and App
After contacting our Partner department, you will receive the following credentials to access the Test environment:
- an
appId
and anappSecret
, to be used with the Authentication endpoint and thus be able to have yourApp
in the Ordatic system - a
storeId
, which represents the id of a test restaurant in the Ordatic test system - an
email
and apassword
, in order to access the Ordatic test system and to manage the information of the test restaurant of the previous point
API Scope
Your App
, in order to have access to the endpoints, must have one or more associated scopes. Right now there are 4 different types:
Scope | Description |
---|---|
Channel | A Channel is a company that develops a physical or software product that helps restaurants increase their sales. |
Pos | A Pos represent a company that develop a physical or software product in which a customer pays for the goods |
Rider | A Rider represents a company that has its own riders and is dedicated to deliveries |
Loyalty | A Loyalty represents a company that helps restaurants with customer loyalty |
In the API Reference of each endpoint we have indicated which scopes have access to it.