Rebuild-Black-Business / RBB-Website

Website to help connect black-owned businesses with consumers and resources
https://www.rebuildblackbusiness.com/
MIT License
119 stars 72 forks source link

[Feature] Add an apiKey Parameter to all Back-End API Requests #311

Closed elchris closed 4 years ago

elchris commented 4 years ago

User Story

This is in preparation for some future enhancements to the API allowing multiple entities to interact with it.

Acceptance Criteria

Is your feature request related to a problem? Please describe.

We are looking to open-up the API to certain parties, and we would like to start tracking all API usage to precise owners. The keys in this issue will be "system keys".

Developers will later-on be able to register their own accounts and manage their own keys.

Describe the solution you'd like

racedale commented 4 years ago

@elchris Is there a reason to send the API key as a Query Param rather than an x-api-key header?

elchris commented 4 years ago

@elchris Is there a reason to send the API key as a Query Param rather than an x-api-key header?

not particularly, i'm cool with x-api-key header. Some folks like to test and troubleshoot "GET" endpoints by "simply pasting a URL in a browser", but I do like the header approach because it's more elegant to implement client side.

So yes feel free to just use an x-api-key header and my implementation will know to look for that.

@racedale

mbifulco commented 4 years ago

Gonna spend some time on this today