API key
 | This article needs additional citations for verification. (October 2018) |
An application programming interface (API) key is a unique identifier used to authenticate a user, developer, or calling program to an API.[1] However, they are typically used to authenticate a project with the API rather than a human user.[1][2] Different platforms may implement and use API keys in different ways.
Usage
The API key often acts as both a unique identifier and a secret token for authentication, and will generally have a set of access rights on the API associated with it.[3]
HTTP APIs
API keys for HTTP-based APIs can be sent in multiple ways:[4]
In the query string:
POST /something?api_key=abcdef12345 HTTP/1.1
As a request header:
GET /something HTTP/1.1
X-API-Key: abcdef12345
As a cookie:
GET /something HTTP/1.1
Cookie: X-API-KEY=abcdef12345
Security
API keys are generally not considered secure; they are typically accessible to clients, making it easy for someone to steal an API key. Once the key is stolen, it has no expiration, so it may be used indefinitely, unless the project owner revokes or regenerates the key.[5] If an API key is meant to be accessible to the client, it is only considered secure if used together with other security mechanisms such as HTTPS/SSL.[4]
Incidents
API keys of Android apps were leaked due to having been hardcoded into apps.[6]
References
- ^ a b "API Key - What is an API Key?". Last Call - RapidAPI Blog. Retrieved 2019-09-20.
- ^ "Why and when to use API keys | Cloud Endpoints with OpenAPI". Google Cloud. Retrieved 2019-09-20.
- ^ IBM Application Security on Cloud (Generating API Keys)
- ^ a b "API Keys". Archived from the original on 2019-10-17.
- ^ Cite error: The named reference
:iraneywas invoked but never defined (see the help page). - ^ "Hundreds of popular Android apps contain hard-coded secret keys". ZDNet. Retrieved 2022-06-20.
Book sources
- De, Brajesh (2017). API management: an architect's guide to developing and managing APIs for your organization (1st ed.). New York: Apress. ISBN 978-1-4842-1305-6. OCLC 978273106.
{{cite book}}: CS1 maint: date and year (link)
External links
7ugho0
 | This computer-programming-related article is a stub. You can help Wikipedia by expanding it. |