bcgov / bcgov/connect

Align API process documentation (internal and external)

Open
#48 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

Isolate “deltas” between three sources of information for the API Request Management process. The objective is ensure all three sources are aligned.
The first internal source is the “**Internal Staff Guide**”. The second internal source is the process document “**API Key Request Process_2024**”.
The third source of information is externally-facing – the **Account Setup page** aimed at API applicants / users.

**Internal Staff Guide:**
PPT: https://bcgov.sharepoint.com/:p:/r/teams/13651/_layouts/15/Doc.aspx?sourcedoc=%7B762F37E6-F7FB-4705-B43E-A98134DF5091%7D&file=Business%20Unit%20Processes%20-%20API%20Request%20Management.pptx&action=edit&mobileredirect=true

PDF: https://bcgov.sharepoint.com/:f:/r/teams/13651/Shared%20Documents/General/Info%20Centre,%20Training,%20Guides%20and%20Client%20Resources/Information%20Centre,%20Training,%20Guides%20and%20Client%20Resources/Management/Staff%20Info%20Centre%20Resources?d=waa9623138f634af68b803b0567b4aed0&csf=1&web=1&e=xaQ7g5
Business Unit Processes - API Request Management.pdf

**Internal Process Document BC Registries API KEY Request Process_2024**
PDF: Connect Sharepoint location: chrome-extension://efaidnbmnnnibpcajpcglclefindmkaj/https://bcgov.sharepoint.com/teams/13651/Shared%20Documents/General/Internal/All%20Teams%20&%20Products/SBC%20Connect%20Platform/Shared%20Documents%20Governance/BC%20Registries%20API%20KEY%20Request%20Process_2024_COMMENTS.pdf?CT=1786116622504&OR=ItemsView

Ownership and Location: unknown. PDF provided by Mihai via email
Suggest contacting Jay Sharp (via Michelle Hoherz) at IT Ops, or Michael Kagis

**External-facing API Instructions (Account Setup page)**
Webpage: https://developer.api.bcregistry.gov.bc.ca/en-CA/products/get-started/account-setup

Ownership: TBD – “developers”

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.