Getting Started

This resource is designed to help various users—whether you're a seasoned developer, a project manager, or a business analyst—navigate the portal with ease. Here, you'll find valuable insights into how to access key features, leverage tools and resources, and maximize the benefits of our platform. Whether you’re looking to integrate APIs, access documentation, this guide will provide the essential information you need to get started efficiently and effectively. Let’s embark on your journey toward enhanced productivity and innovation!

Understand Enterprise Gateway & Developer Portal

So, what is this API Gateway & Developer Portal? Are they referring to the same service?

They are not same; however, they are components of the Enterprise API Platform.

Enterprise API gateway is a central point for managing, securing, and monitoring APIs. It routes requests between clients and backend services. Key functionalities of this service are traffic management, security, monitoring & rate limiting.

Enterprise Developer Portal is a web platform providing developers with tools, documentation, and resources to use an APIs in the Enterprise API gateway. Key features of this service include API documentation, interactive API explorer & subscription management.

Are you an API Provider?

An API Provider is a domain, team, project or individual responsible for creating, managing, and maintaining APIs that expose the organization’s data, services, and functionalities to other departments or teams.

Here are the steps you need to follow to successfully onboard your API into the API gateway as well as expose its documentation to potential consumers via the Developer Portal.

Step 1:

To initiate onboarding an API, we will need some information from you. Please click the button below which will take you to the registration form and our team will set up the initial configuration and reach out to you.

Note:

To configure the API in the API gateway there is some programming involved. We offer two choices.

If you or your team has seasoned developers ready to go hands on and do all of this on your own, go to step 2. This option provides more autonomy, and you will have control over policies and settings of your API.

If you are not sure and will need our team to set this up for you? Not a problem, we will assist you in this. go to step 3. This is a more managed option, where our team will take care of all the technical tasks related to your onboarding.

Specify your choice in the request form.

Please note that you may need to submit your manager's approval for us to complete your request.

Request to onboard an API

Step 2:

Our team will set up the Azure DevOps Project, with all the required scaffolding. and give you access.

You are then free to add required code to the Azure DevOps Project Repository. Our team will assist you in case of any technical issues you have.

You can go to step 4.

Step 3:

Our team Our team will set up the Azure DevOps Project and add all required code to onboard your API into the API gateway. You may be asked to supply technical details related to your API at this stage.

Step 4:

Every new APIs will need to go through a cyber review process. Cyber and architecture team will ensure the API architecture is robust to adhere to Enterprise API Gateway standards and compliance requirements.

Our team will guide you to secure the necessary approvals in this space.

Step 5:

At this stage the API is ready to be deployed to the non-production environment. Our team will manage the deployments steps and get your API available in the non-production environment. You will be supplied with client credentials to test the API.

The non-production environment of the Developer Portal will also have the API now in its catalogue. The documentation will be automatically generated from the API definition in the API gateway.

Step 6:

Once you are comfortable with the non-production environment and ready to release your API into production please submit another request via our web form with relevant approvals. Our team will work with you aligned to your timelines.

Request Production Environment

Step 7:

Once the API is live, consumers can browse its documentation in the Developer Portal as well as integrate them into their applications. Please follow 'Are you an API Consumer' steps to know more details on this.

Explore our detailed training documentation, which will help you navigate these steps with ease!

Are you an API Consumer?

An API Consumer is any application, service, or client that interacts with an API to request data or functionality from an API provider. This can include web and mobile applications, third-party services, or other software components that leverage the API to perform specific tasks.

Here are the steps you need to follow to get access to the API documentation as well as successfully integrate the APIs for your use case.

Step 1:

As a consumer, it's essential to thoroughly explore the API documentation to determine if the API(s) meet your specific use case. To gain access to the Developer Portal, please fill click the button below, which will take you to the registration form. Our team will get in touch with you promptly to assist you with the next steps.

If you already have access to Developer portal and needing to get access for additional APIs, you can use the button below.

Please note that you may need to submit your relevant approval for us to complete your request. This could be a DSA or approval from an authorised personnel.

Step 2:

Once your access is sorted, you will be able to login to the Developer Portal and browse some of the APIs which you had been granted access to.

Explore the API documentation, and check if it is suitable for your use case.

Unfortunately, you will not be able to try out the APIs in the Developer Portal, due to security constraints of the organisation.

Step 3:

As a part of step 1, you will be granted access to the non-production environment of the same APIs too. You will be able to try out the APIs by using popular API client applications like Postman, SoapUI etc. If you are not familiar with API testing, please check the documentation in these websites. If still unsure, reach out to us and our team can assist you. This try out gives you more information on the data that is available and also test out the workflow within the APIs.

If you want to skip this step and directly try to integrate the APIs to your application, you are welcome to do so!

Step 4:

Once you are able to successfully test the API using a client application, you are now ready to try and integrate that with your application. You can use the same non-production credentials you have to implement your use case.

Step 5:

Once you are happy with your implementation and ready to release the integration to production, please submit another request via the production credentials request form to get the production consumer credentials. Our team will attend to this request.

Upon receiving credentials, you can release your implementation to production.

Get Production Credentials

Feeling overwhelmed? No worries!

Check out our comprehensive training documentation designed to guide you through every step of the journey!

Back to Home