search

bcgov / entity

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

submit form for each API Service #16653

Open trishreimer opened 1 year ago

trishreimer commented 1 year ago

-- [ ] Submit form for each API service. Include use cases.

trishreimer commented 1 year ago

Form submitted on June 5th. https://submit.digital.gov.bc.ca/app/form/success?s=0122db02-c476-4cda-9e3a-2420166df756

Sent follow up email June 16th.

From: Reimer, Trish CITZ:EX Sent: Friday, June 16, 2023 11:06 AM To: Hall, Matthew CITZ:EX Matthew.Hall@gov.bc.ca Subject: Question: New Common Component Request Accepted

Hi Matthew, I submitted a request to publish a BC Registries common component and since this process new to me, I’m curious what happens after the form is submitted and how much time do you think it may take to have it reviewed and potentially published? I was planning to submit a couple other forms next week but thought I’d check in before submitting those forms.

I look forward to hearing from you.

Thank you, Trish

trishreimer commented 1 year ago

@Kaineatthelab @thorwolpert @lmcclung - FYI See notes below from Matthew and Karim re: promoting our API's.

From: Reimer, Trish CITZ:EX Sent: Monday, June 19, 2023 10:27 AM To: Hall, Matthew CITZ:EX Matthew.Hall@gov.bc.ca; Gillani, Karim CITZ:EX Karim.Gillani@gov.bc.ca Cc: King, Nia CITZ:EX Nia.King@gov.bc.ca; Rosenburg, Kaitlyn CITZ:EX Kaitlyn.Rosenburg@gov.bc.ca Subject: RE: Question: New Common Component Request Accepted

Okay, I will work on some content to explain each Registry API and why a PO would use the API, then submit each API as a separate form.

Regarding our payment API, just to confirm, are you suggesting we discuss with MOF before we share and promote the Registry payment API with others (either on this API directory page or common component page)?

The $1.50 transaction fee applies to any transaction that has a legislated fee, so it depends on what action is being taken using one of our APIs. The orgbook API is free.

@Gillani, Karim CITZ:EX thank you for sharing the API directory page. I didn’t realize there was an API directory for government. Who owns this and how do we get our API’s added? Does this tie into the common components page within the digital plan or is this something separate?

If it would be easier to have a quick chat about anything, let me know.

Thank you!

From: Hall, Matthew CITZ:EX Matthew.Hall@gov.bc.ca Sent: Friday, June 16, 2023 4:50 PM To: Gillani, Karim CITZ:EX Karim.Gillani@gov.bc.ca; Reimer, Trish CITZ:EX Trish.Reimer@gov.bc.ca Cc: King, Nia CITZ:EX Nia.King@gov.bc.ca; Rosenburg, Kaitlyn CITZ:EX Kaitlyn.Rosenburg@gov.bc.ca Subject: Re: Question: New Common Component Request Accepted

I’ll try to find a middle ground, since we already have PayBC and BC Express Pay on the list, I need to do one of two things:

  1. Produce a minimal topic page with something written for a product owner to know which use case suits each Payment service and then add the BC Registries option or
  2. Potentially remove those two tiles if they are not wanting any payment content posted by us.

I’d like to avoid being stuck in this middle area where we are listing options without adequate direction.

Matthew Hall Common Components Program | Exchange Lab (250) 896-4059

From: Karim Gillani Karim.Gillani@gov.bc.ca Date: Friday, June 16, 2023 at 2:28 PM To: Matthew Hall Matthew.Hall@gov.bc.ca, "Reimer, Trish CITZ:EX" Trish.Reimer@gov.bc.ca Cc: "King, Nia CITZ:EX" Nia.King@gov.bc.ca, "Rosenburg, Kaitlyn CITZ:EX" Kaitlyn.Rosenburg@gov.bc.ca Subject: Re: Question: New Common Component Request Accepted

Matt,

For this particular question: "Would the Common Components team consider creating a new general tile for API's with a vision to add a Service Catalogue for all government API's?” Isn’t this Governments API Catalogue? API Services Portal | API Directory (gov.bc.ca)

As for payment wayfinding site, unfortunately, Ministry of Finance did not support that site being hosted by CITZ as they believe all payment solutions are within their purview. We have since provided OCG a copy of the site suggested for them to consider hosting themselves. As such, I would recommend talking to Ministry of Finance on the best place to add your services as payment options for BC Government Ministries until such time this policy is reviewed and agreed upon by the Ministry of Finance.

Regards,

Karim Gillani (he/him), A/Director, Digital Portfolio | Digital Office Office of the Chief Information Officer | Ministry of Citizens’ Services Karim.Gillani@gov.bc.ca |P: 778-698-2055 | C: 250-507-1581 Acknowledging that the land on which I work, live, and play is on the traditional territory of the Lekwungen peoples, known as the Songhees and Esquimalt Nations.

From: "Hall, Matthew CITZ:EX" Matthew.Hall@gov.bc.ca Date: Friday, June 16, 2023 at 2:05 PM To: "Reimer, Trish CITZ:EX" Trish.Reimer@gov.bc.ca Cc: "King, Nia CITZ:EX" Nia.King@gov.bc.ca, "Rosenburg, Kaitlyn CITZ:EX" Kaitlyn.Rosenburg@gov.bc.ca, "Gillani, Karim CITZ:EX" Karim.Gillani@gov.bc.ca Subject: Re: Question: New Common Component Request Accepted

Hi Trish,

I’ve reviewed your submission: https://submit.digital.gov.bc.ca/app/form/view?s=0122db02-c476-4cda-9e3a-2420166df756 At this point each entry on the list (each tile) needs to be a distinct component. The catalogue doesn’t have the concept of collections of components. We will however have a way to link all of your common components together using some tagging.

If I take a look at one of the individual api, e.g. pay, I am seeing that the documentation and instructions have an audience that is technical in nature.
The goal for the content on each tile will be to help explain to a Product Owner whether your service is something that is targeted for them. So you will need to work on some content for the Product Owner to know why they would or should use the BC Registries Pay API versus the BC Express service or the PayBC service.

I’m copying Karim on this message because I think we may already have content to help with the payment wayfinding. I would have similar questions regarding when I would choose to use the Business Registry API over the Orgbook API.

So next step here may be to get together and talk some more about the content strategy.

Side question, do all of the APIs have the $1.50 / transaction cost?

Matthew Hall Common Components Program | Exchange Lab (250) 896-4059

From: "Reimer, Trish CITZ:EX" Trish.Reimer@gov.bc.ca Date: Friday, June 16, 2023 at 11:06 AM To: Matthew Hall Matthew.Hall@gov.bc.ca Subject: Question: New Common Component Request Accepted

Hi Matthew, I submitted a request to publish a BC Registries common component and since this process new to me, I’m curious what happens after the form is submitted and how much time do you think it may take to have it reviewed and potentially published? I was planning to submit a couple other forms next week but thought I’d check in before submitting those forms.

I look forward to hearing from you.

Thank you, Trish