Prerequisites

• Review and sign the NDA (Non-Disclosure Agreement). If you haven't received an NDA, reach out to [email protected] and we will get in touch with you.
• Review the Versioning & Upgrade Timelines and Quality & Performance Standards for up-to-date content and company-wide standards
• For further assistance, reach out to us at [email protected]

Process Overview

Refer the sections under “Guides” and consult the reference pages for each API. If you have any questions, use the technical support channels shared with you by your Grubtech account manager.

A high-level overview of the full end-to-end integration process is given below:

1. Request test accounts
2. Complete test environment setup
3. Begin development
4. Finalize development & perform end-to-end testing
5. Perform a UAT test for your integration with Grubtech
6. Set up the integration in production
7. Identify and launch on a pilot store
8. Continue launching on new stores
9. Keep the integration up to date with new features

On average, an order platform can be integrated with GrubOne within 3 - 6 weeks. It is up to your team to decide the pace of development.

Test Accounts

The test environment is created by the Grubtech team and you cannot start development without it. Test environments behave very similarly to production environments.

NOTE: No payment information should be required and no couriers should be dispatched for orders placed in the test environment.

To begin the integration process:

1. Submit a tech support request to receive credentials for a test Grubtech account and to setup the integration middleware application on GrubOne.
2. Submit a PGP key and a base webhook URL to complete step 1.

Setting up an environment is a manual process and duration can vary based on different factors. The Grubtech team will request access for test accounts and a test environment for the order platform in order to perform internal validations before proceeding to production.

This process is automated to improve efficiency and tracking. When a staging access request form is submitted; a Jira ticket is created automatically for our development team to start working on the configuration set up.

Request and Response Logging#

Maintain full raw request and response logs for all API calls made between GrubOne and the order platform. This helps trace and troubleshoot issues that can arise during the development and the initial launch phase. After this phase you may opt for only keeping request/response logs on a rolling 3 day window or a time frame that you are comfortable with.

🚧

Our tech support team will request you for request/response logs to help trace problems. We might not be able to resolve certain issues if you are not able to provide them.

Testing with Postman#

Grubtech will provide you the Postman collection link to test the endpoints. This collection will include endpoint request details with parameter setup. The provided link should be used to import the postman collection to your local postman client and start testing the endpoints.

The guide to set up the postman collections is included in the section Postman Testing under the 'Test Cases' page.