Skip to Main Content
Skip to Navigation
Accessibility Statement

API Program Services

BC Data Service (formerly DataBC)

, , ,

The API Program Services (APS) platform is a secure, stable, highly-available API gateway, management portal and directory that handles more than 2.6 billion API requests per year for B.C. government ministries and third-party applications built on public sector data.

Digital teams that develop applications based on B.C. government APIs can use the platform’s API Directory to easily find and securely request access to the APIs they need.

API providers within the B.C. government can use the full range of APS platform services to:

  • Manage all of their APIs in a centralized, secure environment.
  • Configure, test and publish APIs, track usage and other metrics, and enforce API policies across their full life cycle.
  • Implement comprehensive authentication and security including rate limiting, threat protection, encryption, and third-party authentication.
  • Support government-standard digital identities for issuing API credentials, such as IDIR and BC Services Card login.

Control their branding and user experience with customizable URLs.

Why should I use this

Increases the capacity of digital teams

Reduces your infrastructure needs and streamlines internal processes by allowing your team to use APS for routing traffic to your API endpoints, issue and revoke credentials, enforce rate limiting, and report on service metrics.

Promotes trusted discovery and use of B.C. government APIs

Digital teams who are building connected services can easily find and request access to integrate with your API through the API directory, and APIs are published behind the authoritative api.gov.bc.ca domain.

Protects data and simplifies access management

APS provides a consistent approach for APIs that is aligned with B.C. government policy and recommendations. The platform has an in-place Privacy Impact Assessment and Security Threat and Risk Assessment.

About this component

Price

Free

Price details

APS services (including the API gateway, management portal, and API directory) are free to use for anyone with a B.C. government IDIR. Teams using the platform can sign a Service Level Agreement that includes out-of-hours support, which is provided on a cost recovery basis.

Service level support

Support is available for all teams using the platform during business hours, 8:30 am to 4:30 pm Monday to Friday through:

Extended/out-of-hours support: Available 24/7 for clients running critical services with geographic failover. The cost of providing this service is shared equally between all teams with a Service Level Agreement that includes extended support.

Access uptime reports

Additional technical information

The APS Platform uses a combination of custom tools and the Kong API Gateway Community edition. The Platform is deployed in the Gold tier of the B.C. government Private Cloud OpenShift platform run by the Platform Services team.

  • APS supports integration with a range of APIs from commercial-off-the-shelf to custom built.
  • Access control is built in using a variety of options including OIDC, OAuth2.0 and JWT.
  • APS platform functionality includes the ability to define routes and endpoints, set rate limits, manage API keys, etc.
  • Browser-based and command line interfaces are easily available and accessible for managing services.

Advanced functionality is provided through plugins, which allow API providers to extend the platform’s features.

Requirements and restrictions

Developers can log in using their GitHub, IDIR, or BC Services Card identity and start using the platform’s built-in API directory to discover and integrate their applications with B.C. government APIs.

API providers within the B.C. Government can log in with their IDIR and start configuring their APIs immediately. They can then publish their APIs for public or private use on our API Directory. In order to publish, someone in their ministry that oversees data publication must provide their approval.

Getting started

Developers building applications with B.C. government APIs can get started quickly by visiting the API Services Portal and logging in with their GitHub, IDIR, or BC Services Card identity.

The latest platform documentation and release notes can be found on our BC Gov API Services GitHub page.

Support

Support is available for all teams using the platform during business hours, 8:30 am to 4:30 pm Monday to Friday through:

Extended/out-of-hours support: Available 24/7 for clients running critical services with geographic failover. The cost of providing this service is shared equally between all teams with a Service Level Agreement that includes extended support.

Access uptime reports