search

bcgov / DBC-APIM

DataBC OPEN API Services
Apache License 2.0
1 stars 0 forks source link

Design: New Organization Registration #89

Open BK01 opened 6 years ago

BK01 commented 6 years ago

How does a muni get a prod key (no process) - name, org, use this for X, name of api requested.

need to be able to configure registration page (by api owner) based on their req't

Investigate and propose design for a service to enable new organizations such as BC Gov't Ministries, Municipal Governments or Federal Government Ministries to register with Kong and get a production API key. The service should be able to be called from a button in the API console (another button - Request PROD key...food for thought). Or, better yet, as a hyperlink (as a resource) in the BCDC metadata record that invokes the UI, which calls the service, and sends result as an email to the API owner.

Secondly, we wish for API owners to be able to configure a list of questions for organizations or developers to answer (or hardcode mandatory questions). This list of questions may be different for each API owner. Once this form is filled out, the API owner will receive an alert (email) asking them to review the answers to the questions and reminding them to (if approved) provide access to the organization or developer using GWA.

Examples of questions that an API owner may want an organization to answer via a form:

work email address, organization, use this for api, name of api(s) requested.

Third, we wish to remove the need of developers to manually email API owners to request api access. Instead, provide developers with an online form (microservice, gwa?) that they can use to answer questions provided by API owners and select the APIs they wish to have access to using their developer api keys.

The scope of this issue is limited to technically registering an API with DataBC's implementation of Kong.

*Consider a button / link in the metadata record for API (CKAN ext?)

BK01 commented 6 years ago

Need to validate requester How to store identity Result in email to API owner (from api-specs)

BK01 commented 6 years ago

DataBC to compile list of API owner questions, interview API owners, and provide to PIA office.

BK01 commented 6 years ago

@BK01 @mraross to review latest diagram, then @banders to update remainder of doc.

BK01 commented 6 years ago

@banders DataBC review complete. Please proceed with doc update.