# Introduction

Zeek provides food delivery service, and provides Open API to merchants. Developers can enjoy the food delivery service by means of integration between client system and Zeek Open API. It provides seamless integration including order management, store assignment, time prediction, etc.

# Terminology

Term Meaning
Zeek platform Zeek delivery platform which provides various delivery services, including food delivery.
Merchant The merchant(s) who uses Zeek delivery service. For most cases, a merchant represents a restaurant or a store.
Client system The system which calls Zeek Open API endpoints. For most cases, it is the order system of brands or food ordering platforms.
Developer The person who represents client to perform technical integration with Zeek platform.
Partner The person who handles delivery tasks in Zeek platform. It includes riders and walkers.
Delivery order The order created when delivery service is used in Zeek platform. This contains records for service details and used for tracking.
Sales order The sales order in Client system.

# Environment

Developer can use the following environments for Zeek Open API integration:

# Sandbox environment

Developer can develop and test for API integration in Sandbox environment. We provide extra environment for the clients who need customized integration. Please contact Zeek team for this.

# Release environment

Release environment is used for production use.

# Integration procedures

Here are the steps for integration:

# 1. Preliminary discussion

Discussion between merchant and Zeek team for service model, pricing etc.

# 2. Provide information

Developer requires developer account in order to use Open API. Merchant needs to provide the data below for Sandbox and Release environments.

Data Description
Client merchant ID The unique identifier for the merchant or store in Client system.
Client system IP Zeek platform has IP access restriction. Therefore developer is required to provide the Client system IP for access grant.
Order status update callback URL The callback is a HTTP API used for receiving order status updates from Zeek platform. Please refer to API-3.9.1 Order status update callback.

# 3. Obtain developer account

Developer will obtain developer account for each of Sandbox and Release environment. The account includes:

  • App ID
  • App secret
  • API URL

# 4. Development

Developer starts development work in Sandbox environment. Please refer to API endpoints for details.

# 5. Integration test

Integration test aims at testing the API calls between Client System and Zeek Platform. While development is completed, perform integration test in Sandbox environment.

# 6. Pilot test

Pilot test aims at testing the operation flow. It involves partner and store manager to simulate and test the delivery procedures. Please contact Zeek team for pilot test arrangement.

# 7. Go live

When integration test and pilot test are passed, the service can go live!