What should I prepare before publishing an API?
Firstly, you have to host your data on your server and expose an endpoint either in HTTP, HTTPS or SOAP. Second, you have to prepare a request and response definition document describing the way to call your endpoint (e.g. what are the parameters needed) and describing the way to read the response (e.g. what are the fields to be returned).
When you have the endpoint and documentation ready, you are ready to sign-up a publisher account (or login to your publisher account if you have one) to start contributing your data to the data portal.
What are the types of endpoint that can be published?
Currently, we support endpoints in HTTP/HTTPS with JSON and XML as output. We also support endpoints in SOAP with XML as output.
How to sign-up for a publisher account?
You can sign-up a publisher account on the data portal. Your request will be routed to the administrator for approval. After approval, you will receive a notification email to confirm your account.
How to publish an API?
There is a 3-step wizard to publish an API.
In Step 1, you have to provide the general details like:
In Step 2, you have to provide the endpoints details like:
In Step 3, you have to provide some further configurations like:
When you have finished all the steps, you will be prompted with a congratulation dialog box as in below.
How to browse and maintain an existing API?
After you have created the API, you can browse the API by navigating the top menu. You shall see the below screen if you have chosen to view a particular API. You can see the below tag pages:
If you would like to edit the API, click “Edit” at the top.
What is the lifecycle of an API?
In the Lifecycle tab on the API page, you can find the screen below. There is a lifecycle related to an API with these statuses:
How to upload the request and response definition and sample data?
In the Docs tab on the API page, you can find the screen below. You can specify fields below:
For example, the below screen shows that the API is created with a “Request and Response Definition” document and also a “Sample data” document.
When the developer is viewing the API, the documents can be found at the bottom of the “Documentation” tab.
Where can I find the list of developers using the API?
In the Docs tab on the API page, you can find the screen below. This screen shows the developers who are currently subscribing the API.
How can I know the API usage?
You can find a wide range of report in “Statistics” in the top menu.