Autentificare
Chei API de cont, acces complet față de personalizat și unde creezi una.
Fiecare apel către CPI poartă o cheie API. Nu există un id de client separat, nicio negociere OAuth, nicio semnătură de calculat: o singură cheie, trimisă odată cu cererea.
Crearea unei chei
Cheile se află în dashboard, în ecranul Dezvoltatori din meniul contului, în fila Chei API.
Un proiect are propria filă API care creează același tip de cheie, deja limitată la acel proiect,
așa că nu trebuie să tastezi niciodată un app_id de mână. Sandboxul interactiv din Referința API
poate crea și el una pe loc, ca să încerci o metodă înainte de a conecta ceva în propriul cod.
Crearea unei chei API cere verificarea identității, aceeași verificare de nivel 2 pe care o cere Xuda înainte de a oferi un număr de telefon, o căsuță poștală sau o adresă IP portabilă. Un cont fără nimic verificat vede o solicitare de verificare înainte să se deschidă formularul cheii.
Domeniul: în numele cărui cont acționează cheia
O cheie este creată cu unul din trei domenii și acționează întotdeauna asupra contului sau aplicației împotriva căreia a fost creată:
- Cont: acționează direct asupra contului tău, așa cum ai face dintr-o sesiune de dashboard autentificată. Ajunge la fiecare metodă la care poate ajunge o cheie de cont obișnuită.
- Aplicație: creată din fila API proprie a unui proiect, legată de
app_id-ul acelui proiect. - VPS Full Stack: emisă automat când aprovizionezi un VPS Full Stack, limitată la grupurile de capabilități alese la creare. Vezi VPS Full Stack pentru ce acoperă asta.
Accesul: complet sau personalizat
Fiecare cheie alege și cât din suprafața publică poate atinge:
- Acces complet: tot ce poate face contul prin API, inclusiv metodele adăugate după crearea
cheii. Metodele private rămân excluse indiferent de situație:
private: trueeste un zid dur, verificat la fiecare apel, nu o valoare implicită pe care accesul complet să o suprascrie. - Acces personalizat: o listă explicită de permisiuni pe care o construiești bifând metode în
formularul cheii, grupate pe microserviciu, cu câmpurile fiecărei metode afișate pe loc. O metodă
adăugată mai târziu nu este inclusă până nu revii și o permiți. O metodă al cărei
clearanceestepubliceste mereu accesibilă, chiar și pentru o cheie personalizată fără nimic bifat, deoarece o metodă publică nu are nevoie de sesiune și nici de o intrare în lista de permisiuni.
Metodele care creează, actualizează și listează chei API (create_account_api_key,
get_app_api_keys și restul din api_module) nu sunt niciodată accesibile cu o cheie API, în mod
intenționat: o credențială nu poate crea sau edita credențiale pentru contul pe care îl autentifică.
Gestionează cheile din dashboard sau dintr-o sesiune autentificată.
Trimiterea cheii
Prin REST simplu, cheia este încă un parametru al cererii, numit api_key: un câmp în corpul JSON
la POST, un parametru de șir de interogare la GET. Vezi
Apelarea unei metode pentru ambele forme.
Prin MCP, aceeași cheie merge într-un antet Authorization: Bearer, nu există un câmp api_key.
Vezi MCP.
O cheie API este o credențială la purtător: cine o deține acționează ca și contul tău. Nu o pune niciodată în cod de client, nu o comite și nu o lipi într-o captură de ecran partajată. Înlocuiește o cheie imediat dacă apare vreodată într-unul dintre aceste locuri; înlocuirea păstrează numele și modul de acces și revocă valoarea veche în același pas.