Nøgle til programmeringsgrænseflade - Application programming interface key

En applikationsprogrammeringsnøgle ( API -nøgle ) er en unik identifikator, der bruges til at godkende en bruger, udvikler eller kalder program til en API . Imidlertid bruges de typisk til at godkende et projekt med API frem for en menneskelig bruger. Forskellige platforme kan implementere og bruge API -nøgler på forskellige måder.

Anvendelse

API -nøglen fungerer ofte som både en unik identifikator og et hemmeligt token til godkendelse og vil generelt have et sæt adgangsrettigheder på API'en tilknyttet den.

HTTP API'er

API-nøgler til HTTP-baserede API'er kan sendes på flere måder:

I forespørgselsstrengen :

POST /something?api_key=abcdef12345 HTTP/1.1

Som en forespørgselsoverskrift :

GET /something HTTP/1.1
X-API-Key: abcdef12345

Som en cookie :

GET /something HTTP/1.1
Cookie: X-API-KEY=abcdef12345

Sikkerhed

API -nøgler betragtes generelt ikke som sikre; de er typisk tilgængelige for klienter, hvilket gør det let for nogen at stjæle en API -nøgle. Når nøglen først er stjålet, har den ingen udløb, så den kan bruges på ubestemt tid, medmindre projektejeren tilbagekalder eller regenererer nøglen. Hvis en API -nøgle skal være tilgængelig for klienten, betragtes den kun som sikker, hvis den bruges sammen med andre sikkerhedsmekanismer, f.eks. HTTPS/SSL.

Referencer

eksterne links