Todennus
Tilin API-avaimet, täysi ja mukautettu käyttöoikeus sekä mistä sellaisen luodaan.
Jokainen CPI-kutsu sisältää API-avaimen. Erillistä asiakastunnusta, OAuth-kättelyä tai laskettavaa allekirjoitusta ei ole: yksi avain, lähetetään pyynnön mukana.
Avaimen luominen
Avaimet ovat dashboardissa, tilivalikon Kehittäjät-näytössä, sen API-avaimet-välilehdellä.
Projektilla on oma API-välilehtensä, joka luo samanlaisen avaimen valmiiksi rajattuna kyseiseen
projektiin, joten et kirjoita app_id:tä käsin. Interaktiivinen API-viite
-hiekkalaatikko voi myös luoda sellaisen puolestasi saman tien, jotta voit kokeilla metodia ennen kuin kytket mitään
omaan koodiisi.
API-avaimen luominen vaatii henkilöllisyyden varmennuksen, saman tason 2 tarkistuksen, jonka Xuda pyytää ennen puhelinnumeron, postilaatikon tai siirrettävän IP-osoitteen antamista. Tili, jolla ei ole mitään varmennettu, näkee kehotteen varmentaa ennen kuin avainlomake aukeaa.
Laajuus: minä tilinä avain toimii
Avain luodaan yhdellä kolmesta laajuudesta, ja se toimii aina sillä tilillä tai sovelluksella, jota vasten se luotiin:
- Tili: toimii suoraan tililläsi, kuten kirjautuneessa dashboard-istunnossa. Yltää kaikkiin metodeihin, joihin tavallinen tilin avain yltää.
- Sovellus: luotu projektin omalta API-välilehdeltä, sidottu kyseisen projektin
app_id:hen. - Full Stack VPS: myönnetään automaattisesti, kun luot Full Stack VPS:n, rajattuna luontihetkellä valittuihin ominaisuusryhmiin. Katso sisältö sivulta Full Stack VPS.
Käyttöoikeus: täysi tai mukautettu
Jokainen avain valitsee myös, kuinka paljon julkisesta pinnasta se tavoittaa:
- Täysi käyttöoikeus: kaikki, mitä tili voi tehdä API:n kautta, myös avaimen luomisen jälkeen lisätyt metodit.
Yksityiset metodit jäävät pois joka tapauksessa:
private: trueon kova muuri, joka tarkistetaan jokaisessa kutsussa, ei oletus, jonka täysi käyttöoikeus ohittaisi. - Mukautettu käyttöoikeus: nimenomainen sallittujen luettelo, jonka rakennat valitsemalla metodeja avainlomakkeessa,
ryhmiteltynä mikropalveluittain ja kunkin metodin kentät näkyvillä. Myöhemmin lisättyä metodia ei sisällytetä,
ennen kuin palaat sallimaan sen. Metodi, jonka
clearanceonpublic, on aina tavoitettavissa, myös mukautetulla avaimella, jossa ei ole mitään valittuna, koska julkinen metodi ei tarvitse istuntoa eikä sallittujen luettelon merkintää.
Metodit, jotka luovat, päivittävät ja listaavat API-avaimia (create_account_api_key,
get_app_api_keys ja muut api_module-metodit), eivät ole koskaan tavoitettavissa API-avaimella, tarkoituksella:
tunniste ei voi luoda tai muokata tunnisteita tilille, jonka se todentaa. Hallitse avaimia
dashboardista tai kirjautuneesta istunnosta.
Avaimen lähettäminen
Tavallisessa REST-kutsussa avain on yksi pyyntöparametri nimeltä api_key: kenttä JSON-rungossa
POST-kutsussa, kyselymerkkijonon parametri GET-kutsussa. Katso molemmat muodot sivulta
Metodin kutsuminen.
MCP:n kautta sama avain menee Authorization: Bearer -otsikkoon, eikä api_key-kenttää ole.
Katso MCP.
API-avain on haltijan tunniste: kuka sen omistaa, toimii tilisi nimissä. Älä koskaan vie sellaista asiakaspuolen koodiin, lisää sitä versionhallintaan tai liitä sitä jaettuun kuvakaappaukseen. Vaihda avain heti, jos se päätyy johonkin näistä paikoista: vaihto säilyttää nimen ja käyttötilan ja perii vanhan arvon samassa vaiheessa.