Getting started integrating

To integrate the products provided by ZOLOZ with your application, use the phased approach described below to get prepared, implement the integration solution and test the product.


Figure 1. Integration flow

As Figure 1 shows, 3 phases are involved in the ZOLOZ integration:


To get prepared for implementing the integration, perform the following actions:

1. Plan your integration

Before you take any real actions, make a plan of your integration process:

a. Choose the development environment and find out the corresponding service endpoints to be accessed.

ZOLOZ provides separate sandbox and production environments. It is strongly recommended that you implement and test the integration solotion in the sandbox environment before going live in the production environment.

For differernt environments, the service endpoints that you need to access, including the ZOLOZ portal and base API URI, are diifferent. To find out more information about the environment and its related service endpoints, see Understand environments and service endpoints.

b. Choose the integration mode as required.

ZOLOZ provides different integration modes for you to integrate with different ZOLOZ products. Generally 3 kinds of integration modes are supported:

  • App SDK mode: use this mode when your users need to start the ZOLOZ services through your native mobile application.
  • Mobile Web (H5) mode: use this mode when your users need to start the ZOLOZ services via a mobile web browser or a mobile web (H5) application.
  • Pure API mode: use this mode when you want to do a pure server-side API integration.

For more information about each integration mode and the products supported, see Understand integration modes.

2. Set up your ZOLOZ portal account

a. Contact the ZOLOZ solution architect that you are working with to open an admin account for you.

You need to provide information about your email address and the development environment that you use. The ZOLOZ solution architect then opens an admin account based on your requirement. Once the account is ready, you will receive an email that contains a username and password.

If you don't have a solution architect to contact, it is welcome to write to us with your requirements, and we will contact you as soon as possible.

b. Log in to the ZOLOZ portal and reset your password.

Navaigate to the ZOLOZ portal for your specified development environment with your browser, and login with the your username and password. If it is the first time that you log in to the portal, you will be asked to reset your password. After changing the password, you will be redirected to the portal homepage.

ZOLOZ portal account.png

Figure 2. Set up your portal account

3. Get API credentials ready

To ensure the message transmission security between your business and the ZOLOZ service, you need to get the following API credentials ready so that they can be used in the succeeding gateway integration:

  • Client ID: the unique identifier of your account, which is used to trace your transaction. It is generated when your account is created and can be obtained from the ZOLOZ portal.
  • ZOLOZ transaction public key: the public key that you can use to encrypt your request or validate the signature of the response returned from ZOLOZ. It is generated when your account is created and guranteed to be unique. You can obtain it from the ZOLOZ portal.
  • Your transaction key pair: the key pair that is provided by you. Your public key must be registered in the ZOLOZ system so that the ZOLOZ service can use the key to validate the signature of your request or encrypt the response returned to you. You can use the ZOLOZ portal to automatically generate a key pair for convenience, or generate it by yourself.

For more information about how to get the API credentials ready, see Get API credentials ready for use.

4. Integrate the ZOLOZ gateway

To integrate with the ZOLOZ API, you must firstly integrate the ZOLOZ gateway so that API requests and responses can be transmitted and handled correctly. For more information about how to integrate the ZOLOZ gateway, see Integrate the ZOLOZ gateway.


For different integration modes, the integration solution is different. The pure API-mode integration only focuses on the server-side integration with the ZOLOZ APIs, while the App SDK-mode integration and mobile web (H5)-mode integration involves both the server-side and client/mobile web-side integration.

Follow the related integration guide below as you require:


Once you complete the integration, you can test your product to verify whether the integration is successful. It is strongly recommended to test more cases in the ZOLOZ sandbox environment before going live to production.