Autentificering
Konto-API-nøgler, fuld versus brugerdefineret adgang og hvor du opretter en.
Hvert kald til CPI bærer en API-nøgle. Der er intet separat klient-id, ingen OAuth-handshake og ingen signatur at beregne, kun én nøgle, sendt med anmodningen.
Opret en nøgle
Nøgler ligger i dashboardet, under kontomenuens skærm Udviklere, på fanen API-nøgler. Et projekt har
sin egen fane API, der opretter samme slags nøgle, allerede afgrænset til det projekt, så du aldrig
skriver et app_id ind i hånden. Sandkassen i den interaktive API-reference kan også
oprette en til dig på stedet, så du kan prøve en metode, før du kobler noget ind i din egen kode.
Oprettelse af en API-nøgle kræver identitetsverificering, det samme niveau 2-tjek, som Xuda beder om, før der udleveres et telefonnummer, en postkasse eller en flytbar IP. En konto uden noget verificeret ser en opfordring til at verificere, før nøgleformularen åbner.
Omfang: hvilken konto nøglen handler som
En nøgle oprettes med et af tre omfang og handler altid på den konto eller app, den blev oprettet mod:
- Konto: handler direkte på din konto, som du ville fra en logget ind dashboard-session. Når hver metode, en almindelig kontonøgle kan nå.
- App: oprettet fra et projekts egen fane API, bundet til projektets
app_id. - Full Stack VPS: udstedes automatisk, når du klargør en Full Stack VPS, afgrænset til de kapacitetsgrupper, der blev valgt ved oprettelsen. Se Full Stack VPS for, hvad det dækker.
Adgang: fuld eller brugerdefineret
Hver nøgle vælger også, hvor meget af den offentlige flade den kan nå:
- Fuld adgang: alt, kontoen kan gøre via API'et, også metoder tilføjet efter nøglen blev oprettet.
Private metoder er udelukket uanset hvad:
private: trueer en hård mur, der tjekkes ved hvert kald, ikke en standard, som fuld adgang kan tilsidesætte. - Brugerdefineret adgang: en eksplicit tilladelsesliste, du bygger ved at sætte kryds ved metoder i
nøgleformularen, grupperet efter mikrotjeneste med hver metodes felter vist inline. En metode, der
tilføjes senere, er ikke med, før du vender tilbage og tillader den. En metode, hvis
clearanceerpublic, kan altid nås, selv af en brugerdefineret nøgle uden noget afkrydset, da en offentlig metode hverken kræver en session eller en post på tilladelseslisten.
De metoder, der opretter, opdaterer og viser API-nøgler (create_account_api_key, get_app_api_keys og
resten af api_module), kan aldrig nås med en API-nøgle, med vilje: en legitimation kan ikke oprette eller
redigere legitimationer for den konto, den autentificerer. Administrer nøgler fra dashboardet eller fra en
session, du er logget ind i.
Send nøglen
Over almindelig REST er nøglen endnu en anmodningsparameter ved navn api_key: et felt i JSON-kroppen ved
POST, en query string-parameter ved GET. Se Kald en metode for begge former.
Over MCP går den samme nøgle i en Authorization: Bearer-header i stedet, der er intet api_key-felt. Se
MCP.
En API-nøgle er en bærer-legitimation: den, der har den, handler som din konto. Send den aldrig med i kode på klientsiden, læg den aldrig i en commit, og indsæt den aldrig i et delt skærmbillede. Erstat en nøgle med det samme, hvis den nogensinde dukker op et af de steder. Erstatning beholder navn og adgangstilstand og tilbagekalder den gamle værdi i samme trin.