bcgov / bcgov/connect

Document internal API Key Issuance Process

Open
#52 2 comments 0 reactions 1 assignee Claimed by @Eandersongit View on GitHub
connect
Dominant language
No language data
Stars
0
Forks
4
Avg merge
1m
Merged PRs (30d)
2

Description

**Description:**

The external guidance for API clients on requesting sandbox and production API keys is already available in the developer documentation:
[Account Setup](https://developer.connect.gov.bc.ca/en-CA/products/get-started/account-setup)

However, the internal operational process followed by staff to review requests, approve access, issue API keys, and communicate with clients is not documented consistently. (The old version is found from 2024 is really outdated)

Create internal documentation that defines the end-to-end API key issuance workflow for support and operations teams.

Objectives

- Document the internal workflow from receipt of an API key request to key issuance.
- Reduce reliance on tribal knowledge.
- Provide a reference for onboarding and operational support.

Note : Confirm whether the API key issuance process for STRR is the same as the standard process or there are changes in the workflow. If the process is the same, add a reference to this document in the STRR Operations Support and Escalation Path documentation. If it differs, document the STRR-specific process and include a reference to it in the [STRR Operations Support and Escalation Path](https://bcgov.sharepoint.com/:w:/r/teams/09399/_layouts/15/Doc.aspx?sourcedoc=%7BC7BA7723-56E2-480C-87A0-67C6C5716679%7D&file=Operations%20Process%20and%20Escalation%20Path.docx&action=default&mobileredirect=true)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.