bcgov / bcgov/entity

API Access - BTR Search and Filings

Open
#27,816 1 comment 0 reactions 0 assignees View on GitHub
BTR
Dominant language
JavaScript
Stars
23
Forks
62
Avg merge
24m
Merged PRs (30d)
1

Description

> _This issue was auto-created as part of the Zenhub sub-issues migration. The original entity was opened on 2024-07-03. For more details see [this post](https://changelog.zenhub.com/migration-of-epics-projects-to-sub-issues-313645?zenhub_entity_id=Z2lkOi8vcmFwdG9yL1plbmh1YkVwaWMvMjA5MDI1)._

AS a third party service provider (e.g. OWNR)
I wish to have access to the Registrar's Transparency Register API for search and filings
SO I can support my clients in submitting required filings

High level outline of tasks
- public API specs for search and BTR filings (this can't be done on the public site until regulations are deposited, to share with early adopters we would have to give specs offline e.g. through a shared drive)
- update discourse to communicate / share information with API user group
- require NDA's in place until regulations are deposited

*from kial*
- 3rd party api users will already have the ability to access our api
- we will need to add btr documentation here:
- https://developer.connect.gov.bc.ca/en-CA/products / https://developer.connect.gov.bc.ca/en-CA/products/get-started/account-setup
- https://bcregistry-demo.apigee.io/docs/regsearchproxy/1/overview
- we should review / possibly improve payload validation on the backend for our current schema
- we will need a process in place for answering questions on discourse / communicating changes / etc. (maybe we can just be part of the current process?)
- assuming we would fall under existing SLAs -- would be good to know if we have/need any of these for btr filing
- assuming the only 'search' they would have access to are 'business search' and the public 'person search' (i.e. no competent authority search to be offered through the API)

**Options for publishing**
- currently restricted to Doug and Thor
- noted that Kial could get training for this process potentially
- key concerns are that the spec must be detailed sufficiently so it is publishable (review MHR and PPR for examples of the expectation for the spec). E.g. details on responses to be included.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.