API console - corporate key

bcgov / DBC-APIM

DataBC OPEN API Services

Apache License 2.0

1 stars 0 forks source link

API console - corporate key #67

Open BK01 opened 6 years ago

BK01 commented 6 years ago

For consideration with future project phase. To be discussed and determine if feasible, what would the scope of work be.

Q: In the BCDC API console can a government user provide their corporate API key as opposed to their developer key authenticated via GitHub. Perhaps as another button or text box?

banders commented 6 years ago

@BK01 We suggest that to support both integration with GWA and also corporate keys that we should modify swagger-ui as follows:

Beside the "Get API Key" button, add a new button called "Use Existing API Key". The new button will open up a popup window to specify the API key.

I also suggest that we:

Display the active API key next to the buttons, and perhaps also consider adding a third button called "Unset API Key"

We estimate this will take about 1-1.5 days (8-12 hours) effort. Let me know if you'd like us to proceed.

BK01 commented 6 years ago

@banders DataBC has reviewed the proposal. Please proceed with the work to add a 'Use Existing API Key' button, 'Unset API Key' button and active key display.

BK01 commented 6 years ago

DataBC to begin UAT shortly

banders commented 6 years ago

@BK01 @Darv72 I have merged in changes to support corporate API keys. For any gated API there is now a new button "Enter API Key" (beside "Get API Key").

There is a slight complication with the proposed "Unset API Key" button, so I'm holding that back until we can iron out a bug.

In the mean time, feel free to deploy the latest ckanext-openapiviewer in CAD.

BK01 commented 6 years ago

DataBC to deploy in cad.data

BK01 commented 6 years ago

UAT successful in cad.data using Geocoder API console with no key, corporate key, and developer key. Unset API key tested. Tested multiple API keys with specific environment grants.