API Standards
Authorization

Authorization

The following three HTTP Request Header information are required for all endpoints to be used.

This information both shows that you have permission to access data in Adisyo and specifies which restaurant you want to perform operations on behalf of.

HeaderDescription
x-api-keyKey provided by Adisyo for each integrator. You can access this information from Restaurant Settings > Integration tab in the Adisyo application.
x-api-secretSecret information provided by Adisyo for each restaurant. You can access this information from Restaurant Settings > Integration tab in the Adisyo application.
x-api-consumerCan be the restaurant name or the company name performing the integration. If integration is being done for multiple restaurants, a different value should be used for each one. This information is important for us to identify you in incoming requests.

Getting API Access Information

This information must be in the header field of the HTTP request to be sent, otherwise the operation will not be performed.

You can access x-api-key and x-api-secret information from Restaurant Settings > Integration tab in the Adisyo application.

Consumer Key Information

This is a required field for each restaurant to be integrated.

This field is one of the most confused pieces of information. But essentially, it just helps us identify the restaurant making the request or the external company operating on behalf of that restaurant.

In this section, the name of the integrated restaurant or information that will identify it can be sent. If it is a software company, it can send the company name, but if a software company is providing integration for many restaurants, it must send different x-api-consumer information for each restaurant.

Examples

  • --header "x-api-consumer: BenimKuryem.net"
  • --header "x-api-consumer: KuryeSepeti - Kardeşler Kebap"
  • --header "x-api-consumer: Burger Art - Web Siparişleri"

For issues related to integration or for x-api-key/x-api-secret information, you can reach us here (opens in a new tab).