Connect your Application Programming Interface (API) to the API Services Portal
The B.C. government API Services Portal makes it easy to connect with applications and systems across government.
About the API Services Portal
The B.C. government has an API management tool called the API Services Portal. It includes an API gateway and serves as a central entry point for API requests between different applications.
This tool helps B.C. government developers and digital teams use their APIs safely and reliably by controlling and managing access. You can request to use listed APIs through the tool’s API Directory.
How it works
The API Services Portal was built using an open-source tool called Kong Gateway. A gateway is a server that acts as an entry point to manage and route API requests.
A benefit of being open-source is that anyone can securely review how it’s built and suggest improvements. This openness helps the government ensure that our technology is transparent, modern and aligned with industry best practices.
Features
The API Services Portal offers many features for developers and digital teams, such as:
- Routing, which supports in directing requests to the correct API
- Load balancing, which distributes requests evenly to keep the system running smoothly. For example, when you encounter a “Too Many Requests” error on a webpage, it means that an API has stopped sending information to that website. Using an API gateway protects applications from these types of issues
- Authentication, to verify that only the right applications are accessing the API
More features and tools are available by downloading Kong Gateway’s optional plugins.
Benefits
The API Services Portal:
- Can boost performance by providing developers with insights into API usage, such as the number of API calls, response times and error rates
- Is designed for ease of use
- Has a quick onboarding process for developers who want to share and/or protect their APIs
Offers a standardized, reusable building block that performs specific functions reliably for developers and digital teams working on B.C. government applications. This ensures API gateway use is consistent and follows government policies and best practices.
How to get started
If you have an IDIR, you can start managing your APIs today by logging into our user-friendly API Services Portal. Within the portal you can:
- Define, configure and manage API endpoints to ensure proper connectivity and access
- Set up and manage security measures. This includes authentication, authorization and access control to protect sensitive data
- Implement and adjust rate limitations to control and optimize your API’s usage
- Monitor your API’s performance, track usage analytics and gather insights to ensure optimal functionality and identify potential issues
Understand how the API Program Services team can support you.