Get Started
Here you can find the top 5 steps to get you started.
-
Browse our API Catalogue
Browse our API Catalogue to discover and leverage REST APIs and find the most suitable ones for your Apps. View SmartDocs with 'Try it out' feature enabled to experience our APIs on-the-spot without any prior setup.
-
Create Your App
Once you have logged in successfully, you need to create your app and get API keys. Navigate to My Apps page to create your first app.
-
Get Your App Key
Once your app's status is approved by the API Product Manager, you can use the API key. You can see your API key and secret by:
- Visiting the Apps page
- Selecting the your approved API
- Your API key is listed as 'Consumer Key'. The corresponding secret is listed as 'Consumer Secret'.
This Consumer Key and Consumer Secret should be used for authentication when you make API calls.
-
Try Out Sandbox APIs
The next thing to do is to start experimenting with our APIs to develop your app. You should do this in the Sandbox environment that we provide specifically for this purpose.
Sandbox APIs will allow you to successfully try out our APIs, by sending real API calls with the required data and getting real responses. The Sandbox APIs are, however, hosted in a Sandbox environment, which is solely for the purpose of experimenting with the APIs.
The Sandbox API are the same as the Production APIs except that you don't get access to the live customer data or allow you to carry out live transactions.
-
Request Production API Access
When you have successfully tested our Sandbox APIs and built an app using our Sandbox APIs, it's time to launch your app with the Production APIs. You can request for a Production app from the API Portal.
Your request is reviewed and once approved, you will have a new Production app with a new set of keys. You will have to update your app to use these new Production keys and point the API endpoint to the Production API endpoint. You are now ready to launch your app!