Get started

There are many things mentioned in this portal. I am not sure where to start?

All good! We get it. Browse through our Getting Started pages and we are sure you will be at ease to navigate the portal.

Sign in

When I try to sign in, it gives an error.

The authorised content of this portal, will be available to those zId's that are configured to access the portal. So if you see an error when you try to sign in with your zId, it is most probably due to your login not added to the Azure Control group. Please submit a request via this form and our team will reach out to you. If you prefer to request access for any specific API documentation, you can do this via the same form.

Request access

How do I request access to the API documentation?

Please submit a request via this form and our team will reach out to you.

I am not sure of the name of APIs that I need access to. How can I know what is available and then request for what I need?

The list of APIs is only available to authorised users. You may add comments in the request form with the type of datasets or data domains or any source applications you are interested in consuming data from. Our team will reach out to you and do the needful.

API catalogue

As an API consumer what are the steps, I need to follow to get access to the documentation, APIs and integrate applications with them?

Please refer the section 'Are you an API Consumer' in our Getting Started pages.

I can sign in successfully. But I do not see any APIs listed in the 'APIs' page.

If you can sign in successfully, but still not able to see any APIs or not able to see some specific API's, the reason is that you will need to be configured with the specific authorisation rules. Please submit a request via this form and our team will reach out to you.

I can see the APIs I need and browse the operations available. Now I would like to test them. How can I get the test credentials?

Please submit the request form with the section 'API Credentials' filled out. Ensure that you have uploaded your approval to use the APIs from your manager in the SharePoint location provided in the form. If you have trouble uploading the approval, please forward it to our contact email address.

I am new to APIs. What tools do I need to try out APIs?

There are plenty of applications available for free on the internet to test APIs. Some examples are Postman, SoapUI etc. These sites provide learning resources to help you set up requests. If you have trouble using these tools reach out to us and our team will be happy to help with the query.

Can I try out testing the APIs through this portal?

Unfortunately, that option is disabled in this portal due to various security constraints. You will need to get the credentials for the API and test them using any API testing tools available.

I can see the list of APIs. How do I see their details?

Each item in the API list provides a click through feature to an API detail page. This page list all the operations available in the API, their request and response formats, response codes and other relevant metadata.

Onboard an API

How do I know if an API is qualified to be onboarded to the Enterprise API gateway?

The guidelines for an Enterprise API are outlined in these pages. Please refer these and reach out to us in case of any queries.

As an API Provider what are the steps, I need to follow to get my API onboarded in the Enterprise API gateway and also load its documentation in this developer portal?

Please refer the section 'Are you an API Provider' in our Getting Started pages.