FAQs - Food Aggregators
General
What can I do in the Grubtech developer portal?
Grubtech developer portal provides comprehensive support to continue the integration process. It consists of detailed instructions, API endpoint details, testing support, and several other guidance to make the integration process smooth and error-free for the external developers.
Where can I find your Terms and Conditions?
Grubtech team will provide you the NDA document before start any integration process. You can review the terms and conditions on there and act accordingly.
How do we know the latest versions of APIs?
Latest version details are updated through Versioning and Upgrade Timelines section
Partner Accounts
What is a Grubtech Partner Account?
Grubtech businesses are mostly hand-in-hand with several other parties. So, it is essential to have a mechanism to connect Grubtech and those parties. These parties include third-party service providers like logistics providers, POS systems, food delivery aggregators, etc... and are known as partners in Grubtech context. To enable the interaction with those partners Grubtech system has established an integration platform. Through this platform, external partners can request integration with Grubtech and the 'Partner Account' will be their main place of configuration to fulfill required interactions.
How to apply for a partner account?
First, you need to read and sign the NDA document with Grubtech. After that, the Grubtech operations team will put you through the onboarding process with partner account creation.
How can I create Grubtech partner account?
You’ll need to first create and register with a partner account. Grubtech team members will configure an account for you and support you with the onboarding process. Please visit [account creation link] to start creating the partner user account. Once you have a Grubtech partner user account and have logged in, you can set up menus, kitchens, stations, etc.. and then refer relevant APIs to continue endpoint implementations. Please make sure you fully agree with our API Terms of Use and Display Requirements.
How will I be notified about my account creation?
You will be notified with updates about your application via the email address you verified before submitting your application. We will continue to use this email for all correspondence about your application, even if you later change the email associated with your Grubtech account in your Grubtech App settings.
Authorization
What is an API Key?
An API key is a unique identifier used to connect to, or perform, an API call. API key act as a secret authentication token and typically comes with a set of access rights for the API that it is associated with. The API call starts with one API calling another and then passing the API key to gain access. The API key establishes the connection and may track access rates for billing purposes depending on the rules of the API owner.
What is OAuth2?
OAuth 2.0 is an authorization protocol designed primarily as a means of granting access to a set of resources. OAuth 2.0 uses Access Tokens which is a piece of data that represents the authorization to access resources on behalf of the end-user. OAuth2 allows authorization without the external application getting the user's email address or password. Instead, the external application gets a token that authorizes access to the user's account. The user can revoke the token for one application without affecting access by any other application.
How long does an access token last?
Access tokens are not explicitly expired. An access token will be invalidated if a user explicitly revokes an application in their partner account settings, or if Grubtech suspends an application. If an application is suspended, there will be a note in the Grubtech app dashboard stating that it has been suspended.
What are the types of OAuth2 tokens in Grubtech?
There will be three tokens:
- id_token - This token will be used to grant permission in GrubTech
- access_token - This will not be used by GrubTech platform
- refresh_token - This token is used to get new access and id token. Above tokens except access_token will be returned to the 3rd Party Application. There’s no need for 3rd Party Application to have the access_token
Platforms
What are the different platforms in this portal?
- Ordering platform: Enables integration with different order sources
- Logistics Platform: Enables integration with logistics partners
- POS Platform: Enables integration with POS systems
Are there any guidelines or terms which I should know while using the APIs?
Please refer our Quality and Performance standards section for more details.
Integration
How to start integrating order platform?
Create a partner account contacting Grubtech internal team and configure required kitchen, station, brand and menu details. Then start the integration process following the Menu Integration and Order Integration guided sections.
Whom to contact for customer queries?
Contact [Customer Support Service] for further queries
How many API requests do I receive? What happens if I exceed my daily limit?
[TODO] By default, you will receive 5,000 calls per day. Any call you make after that on the same day will get back a response with status code 429 (Too Many Requests). Daily limits are reset every midnight UTC time. main products, grubONE, uses bi-directional integrated APIs to automatically deploy menus across various channels and automate order capture from food aggregators into a unified and easy to manage dashboard.
Testing
How can I set up a test account?
Submit a tech support request to receive credentials for a test Grubtech account and to set up the integration middleware application on GrubOne. This will start the test account creation process.
How do I test my app?
You will have to build a test environment to perform testing tasks. Test environments behave very similarly to production environments. No payment information should be required and no couriers should be dispatched for orders placed in the test environment. The Grubtech team will provide access to test accounts and a test environment for the order platform to perform internal validations before proceeding to production.
How do I find input data to test?
You can refer Test Cases section for general test inputs and contact out operations team for edge case test inputs.
How can I test request and responses?
Use post man collection provided in the [Order API Postman Collection] and [Menu API Postman Collection] to test the request and responses. Use [Postman testing instruction] guide to follow the steps to run the collection items.
Maintenance
How can I report an issue?
Contact our [customer support services] team to inform about issues
Where to find error definitions and details?
Use Errors and Response Codes section to refer error details.
Updated about 2 months ago