# Introduction

Open API allows developer to use ZeekSolutions SaaS service by means of technical integration. With Open API, developers can manage delivery orders and their status. This document explains the integration details.

# Terminology

Term Meaning
Client system The system which calls ZeekSolutions Open API endpoints. For most cases, it is the order system of ZeekSolutions SaaS client's ordering platforms.
Merchant For most cases, a merchant represents a restaurant, store or outlet.

# Environment

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

# Development environment

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

# Production environment

Production 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 Development and Production 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

# 4. Development

Developer starts development work in Development 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 Development 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!