Hitelesítés
Fiók API-kulcsok, teljes és egyéni hozzáférés, és hol hozható létre egy.
A CPI minden hívása hordoz egy API-kulcsot. Nincs külön kliensazonosító, nincs OAuth-egyeztetés, nincs kiszámítandó aláírás, egy kulcs van, a kéréssel együtt elküldve.
Kulcs létrehozása
A kulcsok az irányítópulton vannak, a fiókmenü Fejlesztők képernyőjén, az API-kulcsok lapon. A
projektnek saját API lapja van, amely ugyanilyen kulcsot hoz létre, már a projektre korlátozva, így soha
nem kell kézzel beírnia egy app_id értéket. Az interaktív API-referencia homokozó is
létrehozhat egyet helyben, így kipróbálhat egy metódust, mielőtt bármit a saját kódjába építene.
Az API-kulcs létrehozásához személyazonosság-ellenőrzés kell, ugyanaz a 2. szintű ellenőrzés, amelyet a Xuda telefonszám, postafiók vagy hordozható IP kiadása előtt kér. Az olyan fiók, amelyen semmi sincs ellenőrizve, a kulcsűrlap megnyílása előtt ellenőrzésre szóló felszólítást lát.
Hatókör: melyik fiók nevében cselekszik a kulcs
A kulcs három hatókör egyikével jön létre, és mindig azon a fiókon vagy alkalmazáson cselekszik, amelyre létrehozták:
- Fiók: közvetlenül az Ön fiókján cselekszik, úgy, ahogy egy bejelentkezett irányítópult-munkamenetből tenné. Elér minden metódust, amelyet egy sima fiókkulcs elérhet.
- Alkalmazás: a projekt saját API lapjáról létrehozva, a projekt
app_idértékéhez rögzítve. - Teljes körű VPS: automatikusan kiadódik, amikor Teljes körű VPS-t helyez üzembe, a létrehozáskor választott képességcsoportokra korlátozva. Hogy ez mit fed le, azt lásd a Teljes körű VPS oldalon.
Hozzáférés: teljes vagy egyéni
Minden kulcs azt is megválasztja, a nyilvános felület mekkora részét éri el:
- Teljes hozzáférés: minden, amit a fiók az API-n keresztül megtehet, a kulcs létrehozása után hozzáadott
metódusokat is beleértve. A privát metódusok bármi történjék is kizártak maradnak: a
private: truekemény fal, minden hívásnál ellenőrzik, nem olyan alapértelmezés, amelyet a teljes hozzáférés felülír. - Egyéni hozzáférés: egy kifejezett engedélylista, amelyet a kulcsűrlapon metódusok bejelölésével épít,
mikroszolgáltatásonként csoportosítva, minden metódus mezőivel sorban megjelenítve. A később hozzáadott
metódus addig nem tartozik bele, amíg vissza nem tér, és nem engedélyezi. Az a metódus, amelynek
clearanceértékepublic, mindig elérhető, még az olyan egyéni kulccsal is, amelyen semmi sincs bejelölve, mert a nyilvános metódushoz nem kell munkamenet és engedélylista-bejegyzés.
Az API-kulcsokat létrehozó, frissítő és listázó metódusokat (create_account_api_key, get_app_api_keys és
az api_module többi része) szándékosan soha nem lehet API-kulccsal elérni: a hitelesítő adat nem hozhat létre
és nem szerkeszthet hitelesítő adatokat annak a fióknak, amelyet hitelesít. A kulcsokat az irányítópulton vagy
bejelentkezett munkamenetből kezelje.
A kulcs elküldése
Sima REST esetén a kulcs még egy kérésparaméter, api_key néven: egy mező a JSON-törzsben POST esetén, egy
lekérdezési karakterlánc-paraméter GET esetén. Mindkét alakról lásd a Metódus hívása
oldalt.
MCP esetén ugyanez a kulcs egy Authorization: Bearer fejlécben megy, api_key mező nincs. Lásd az
MCP oldalt.
Az API-kulcs hordozói hitelesítő adat: aki birtokolja, az fiókja nevében cselekszik. Soha ne szállítsa kliensoldali kódban, ne commitolja, és ne illessze be megosztott képernyőképbe. Azonnal cserélje le a kulcsot, ha valaha ilyen helyen felbukkan, a csere megtartja a nevet és a hozzáférési módot, és ugyanabban a lépésben visszavonja a régi értéket.