CSB 005

November 18th 2022

What is happening?

Access to our hosted services will be migrating to leverage the API Services Portal at api.gov.bc.ca. The following two APIs are affected:

• Common Hosted Email Service (CHES)
• Common Document Generation Service (CDOGS)

If you currently use either of these services, you will need to request a new set of credentials using the API Services Portal.

Why?

We believe the API Services Portal and Gateway service offered by a dedicated team at the Ministry of Citizen Services will provide a better onboarding service for our API consumers. This move also allows us to reduce duplication of efforts and resources (such as Keycloak realms and the onboarding web interface)

When is this happening?

Please request access through the Portal at your earliest convenience. You are encouraged to start using the new credentials and endpoints as soon as possible. At the end of December 2022, access to these services using your old credentials will no longer work.

What should You do?

1. Go to the API Services Portal and find the API in their Directory. Click ‘Request Access’ and sign into the portal. Fill in our request form and choose the environment you want to access. Please provide contact information of the Product Owner as well. This must be repeated for each environment.
2. The Common Service Showcase team will complete the request and notify you soon after and your credentials will become active.
3. Update your client application with the new credentials and API endpoints.

Important Notes

• With this change, you will now require a separate set of credentials (Client ID and Client Secret) for each of our hosted services that you use. There is one token endpoint for both services.

• The API hostname is changing for both API’s. Please call these new endpoints:

• CHES:

  • https://ches-dev.api.gov.bc.ca (dev)
  • https://ches-test.api.gov.bc.ca (test)
  • https://ches.api.gov.bc.ca (prod)

• CDOGS:

  • https://cdogs-dev.api.gov.bc.ca (dev)
  • https://cdogs-test.api.gov.bc.ca (test)
  • https://cdogs.api.gov.bc.ca (prod)

• These new credentials will continue to use the same existing OIDC client credential grant flow.

If you have any questions, please feel free to contact us here in the #nr-common-services-showcase RocketChat channel or by email nr.commonserviceshowcase@gov.bc.ca

Thank you.