API Integration
What is an API?
API stands for Application Programming Interface. It’s a set of rules and protocols that allows different software applications to communicate with each other. It provides a standardized way for different software components to interact.
When we talk about an API integration, it means that two separate systems share data or functionality through their APIs. This enables data or actions from one application to be sent to another.
For example
Sitedish integrates with various accounting systems. By having an API integration between Sitedish and these systems, delivery & takeaway orders can be automatically synchronized with the accounting system without manual input. The API integration then facilitates streamlined data exchange between the two systems.
In short
An API key always belongs to one restaurant and only gives access to the data of that restaurant.
You request an API key per restaurant through our support team. POS integrations can start right away, without a review by us. For other integrations we ask you to describe what you want to use the API for. We review that request.
Working as an integration partner for a restaurant? You need the permission of that restaurant.
Orders include the customer details needed to process them, such as name, address and phone number. Those details are shared only so you can process that order. Do not use them for anything else, such as marketing or analysis.
Need more than the API offers today? Contact us. We may be able to make more endpoints available.
Full policy and documentation
The full API policy and the technical documentation are at api.sitedish.nl/docs.
Questions, or want to request an API key? Email info@sitedish.nl.
OAuth2 protocol
To access the Sitedish API system, the OAuth2 protocol is used.
This protocol controls the actions an API can perform after a user has given permission. The main advantage is that user login credentials are not shared between the user and the API, enhancing security. Here’s a brief and simple explanation:
- 1
Purpose: OAuth2 allows the API to access certain resources on a server on behalf of a user, without needing the user’s login credentials.
- 2
Authorization: It starts with a user granting permission for the API to do certain things, done through authorization requests.
- 3Token issuance: After the user grants permission, the API receives access tokens. These tokens are used to access secure resources on the server.
- 4Token usage: The API uses these tokens to perform specific actions on behalf of the user, such as retrieving data.
- 5Scope: It specifies the specific actions the application can perform with the obtained tokens.
Sitedish Integrations
Over the years, Sitedish has attracted various partners, many of whom have an API integration with Sitedish. Sitedish’s clients (delivery & takeaway restaurants) then utilize these integrations.
