Getting Started

Follow the steps below to start testing with our APIs and go live.

Step 1: Create an account

  1. To create an account for testing in Sandbox, simply click ‘Register’ on the navigation menu and complete the registration form to proceed.
  2. Once your account is created, an email containing the activation link will be sent to your registered email account.

Step 2: Activate your account

  1. Click on the URL in the email to activate your account.
  2. You can now sign in with your credentials and browse our API catalog.

Step 3: Register your app

  1. Before subscribing any APIs, you must first register your app on APIX by clicking ‘Apps’ on the navigation menu.
  2. Click the ‘Create New App’ button on the top right corner of the Apps page and complete the application form.
  3. For certification section, you can paste the content of your application's X.509 certificate directly into the form.

Step 4: Get your API Key & Secret

  1. The API Key and Secret of the app will be generated once the app is registered. These will be used to authenticate your app when activating APIs.
  2. The Secret will only be displayed once. Please copy and keep it safely for your records.

Step 5: Subscribe to API

  1. Browse our API catalog from ‘API Products’ on the navigation menu.
  2. Click ‘Subscribe’ once you have selected the desired API.
  3. To complete the subscription, you will be asked to select one of your registered apps.

Step 6: Activate API for testing

  1. The documentations of the API can be found on the menu within the product page.
  2. You can now retrieve the API data to your app with the API URL, API Key & Secret and access the Sandbox environment for testing.

Step 7: Go Live

Ready for the real thing? Simply integrate the tested API to your product and introduce it to your customers by clicking ‘Go Live’ on the navigation menu with the instructions below:

 
  1. Select New Registration in the TSP Registration Form if you are a first-time applicant for Live environment.
  2. Complete the form and upload all required documents.
  3. An acknowledgment email will be sent to confirm the receipt of your registration.
  4. After reviewing your registration, you will be notified by a further email. A URL to access the Live portal will be attached for approved requests.
  5. Wish you great success with your new product!