search

bcgov / entity

ServiceBC Registry Team working on Legal Entities
Apache License 2.0
23 stars 59 forks source link

Add Terms of Service Link into our API/HTML responses #19896

Open mstanton1 opened 9 months ago

mstanton1 commented 9 months ago

For business search and director search add the Terms of Services (TOS) link into BC Registries API/HTML responses.

To be added: Updated Terms of Service document. Note this is currently with LSB being finalized.

mstanton1 commented 9 months ago

@DJ-Gordon @daniwilliamson can you review and confirm the request above? Please let us know when API Terms of Service are available.

DJ-Gordon commented 9 months ago

@mstanton1 The new standardized TOS for REG APIs will be available for review by the end of the week. Are you aware of any special considerations for Business or Director Search services, that should be included via Appendix?

DJ-Gordon commented 9 months ago

@Kaineatthelab

Melissa is referencing the creation of an HTML version of the TOS. My understanding is that we want all API users to sign (with you counter signing) on all Registries API agreements.

Is this HTML version intended to just be for user reference?

mstanton1 commented 8 months ago

@Kaineatthelab for the NRQ to move over the API GW the design intention is to include Terms of Service within the site as well as manage terms updates in an automated fashion. Can you confirm you are comfortable with this becoming an automated process for API users rather than the current paper process for API Terms?

cc @DJ-Gordon @daniwilliamson

Kaineatthelab commented 8 months ago

Yes if they agree to the terms then that is essentially signing them and now not necessary for my review. However there is a requirement to make sure we are automatically notified of new API accounts so we can have an understanding of the marketplace for it. For data purposes, it would be good to be able to show all the API accounts like @gprimeau is doing but also show by sector and application:)

mstanton1 commented 8 months ago

Thanks @Kaineatthelab! @DJ-Gordon @daniwilliamson we will need a copy of the current terms. If there's other work blocking this, if you provided the current version I could have my BA strip out the header / footer and update the reference from Queen to King in order to get this to Thor soon:)

daniwilliamson commented 8 months ago

Yes if they agree to the terms then that is essentially signing them and now not necessary for my review. However there is a requirement to make sure we are automatically notified of new API accounts so we can have an understanding of the marketplace for it. For data purposes, it would be good to be able to show all the API accounts like @gprimeau is doing but also show by sector and application:)

@DJ-Gordon @Kaineatthelab - @gprimeau added some functionality to the dashboard to show sector and application. Ideally, it would also be great to see if the API user has been approved for Sandbox vs PROD. We weren't sure if we could see that distinction in the data.

DJ-Gordon commented 8 months ago

@mstanton1 Sent you the latest API agreement terms for "Agree" style user acceptance

mstanton1 commented 8 months ago

@daniwilliamson I can chime in on your question above regarding access. There are unique keys for Sandbox and Production environments but in sb-auth we only track if somebody has API access and not which environment that access is for. Thor is aware of this ask and if there's capacity his team will improve the current functionality and add a transaction history in Sandbox (already have this in PROD) so we can see what a user is accessing and how active the users are.

daniwilliamson commented 8 months ago

@daniwilliamson I can chime in on your question above regarding access. There are unique keys for Sandbox and Production environments but in sb-auth we only track if somebody has API access and not which environment that access is for. Thor is aware of this ask and if there's capacity his team will improve the current functionality and add a transaction history in Sandbox (already have this in PROD) so we can see what a user is accessing and how active the users are.

Thank you, Melissa! Great info - most appreciated. @gprimeau - heads-up, Melissa has answered our question :)

FYI @DJ-Gordon

mstanton1 commented 2 months ago

@sandragornall @thorwolpert I don't believe this was implemented. With your work to understand potential items that SBC Connect could pick up you may wish to add this to the list. Note, I have not added your label as I see two for SBC Connect and am not sure which one you are using.