Review and update Get Started process on Daxiom's API page

[magszymanski]

The API Daxiom "Get Started" page containing the API process needs review. For example, when we launched the PPR API, the process shifted to keys being released through the user's Premium dashboard and not via email. Is that still accurate and are there any other changes to this now?

Request for a BA to review this process. This doc can be used to capture changes at which point Doug or Thor will need to make updates.

[magszymanski]

@trishreimer @Maribeth-Wilson
I've created this ticket to capture the work to update the Get Started API process. I'm away after today - could you please see who would be the appropriate BA to take on this task? Sienna is leaving so maybe Patrick or Zac? Cameron may have insight given that BC Registries get the initial request for APIs.

[PatrickAHeath]

Template for OPS API Key Request:

ticket title: [INCIDENT NUMBER] - [COMPANY NAME] - [ENVIRONMENT] API REQUEST

ServiceNow incident:

COMPANY NAME:

ACCOUNT NUMBER:

Description

• [ ] Terms of Service (TOS) completed. Date is correct and Customer has signed on behalf of the account.
• [ ] Account Number to use has been provided

TEST API KEY PROCESS

FIRST STEPS:

• Staff receive API Request to their staff inbox
• If engagement inbox receives it, forward it to staff
• Staff verify that the client has a PAD account (if not, forward to us to assist the client)
• Staff check if the client has already requested an API key before, and if the first time, ask them to sign a TOS
• Staff verify that the TOS has been signed, and then store it in 'R:\ARCS\Admin 100-499\Agreement Negotiation_Mgmt 146\45 Approved internal_local agreements\API Terms of Service Agreements'
• Staff forward email to BC Inbox, and include IT Ops so they can make a service now incident. Email includes:
  • If client has set up PAD payment, and if not, what they currently have set up.
  • If the client has successfully signed the TOS
  • The client's account number

OPS STEPS:

• [ ] When ticket has been created, post the ticket in RocketChat '#Operations Tasks' channel
• [ ] Reply All to IT Ops email (CC BA Inbox) and provide zenhub ticket number opened
• [ ] BA verifies that the person requesting has Pre-authorized Debit (PAD) set up as their account payment method.
  • if the client has an existing account but wants to keep that other one with another payment method, suggest the client make a new PAD account.
  • If they are authenticated with BCSC, they can set up another account with the same BCSC. If they are authenticated with BCeID, they will need to create a new BCeID, and authenticate with that.
  • If BCeID, they can upload the existing affidavit they used for their other account (as long as they are still the same person, if not, they will need a new affidavit. POs have decided that clients should complete this action, and it doesn't take more than a day or two to complete. If the client is upset, escalate to POs.)
  • We can expedite the approval of the affidavit by emailing bconline@gov.bc.ca
• [ ] SRE team create api-key
• [ ] BA email client and inform them that their key is now available on their dashboard.
• [ ] Close Zenhub ticket
• [ ] Tell IT Ops to close the ServiceNow Incident

Signed TOS does NOT need to be stamped by staff.

FAQs for setting up PAD can be found here.

PROD API KEY PROCESS

• [ ] Staff or ba inbox recieves PROD API request
• [ ] Staff or BA verifies that they have previously had a TEST API key
  • If not, ?????
• [ ] Staff or BA verifies that the client has a signed TOS agreement
  • If not, ask them to follow the insturctions here: https://developer.bcregistry.daxiom.ca/get-started/
• [ ] BA informs SRE team
• [ ] SRE team generate key
• [ ] BA informs client that their key is available on the dashboard

[jinghualicgi]

@PatrickAHeath @magszymanski Hi, as discussed in our standup, Patrick will follow-up with Doug and Thor for API Client Setup in Sandbox for Ops process

[trishreimer]

@PatrickAHeath what is the status?

[PatrickAHeath]

@trishreimer Still on the back burner with all the other priorities - plus, I'm covering OPS for John this afternoon.

[fareenr]

13-May - met with Patrick to determine gaps in information for API key requests for new mock env, API key tracking. The Get started Daxiom API page will need to be updated slightly. Some questions to confirm with Thor first.

[fareenr]

I have drafted updates to the Getting Started with APIs page for end users. Draft under review by John: https://docs.google.com/document/d/14jh43DtPrZZHYY0upSkzWnRnyQRisk2t0z5Wjspn7yg/edit

[jinghualicgi]

@fareenr Should we move this ticket to Review pipeline and assign to John? Thanks

[fareenr]

25-May - Created ticket # 12350 for Daxiom to update the text on the Getting Started with APIs webpage

[fareenr]

30-Jun -does not appear to be assigned or updated yet, followed up with Thor

[trishreimer]

Let me know if I can do anything to help move this forward.

[fareenr]

27-Jul - webpage is updated now