Authentication
API kľúče účtu, plný a vlastný prístup a kde ho vytvoriť.
Každé volanie CPI nesie API kľúč. Neexistuje samostatné id klienta, žiadna výmena OAuth, žiadny podpis na výpočet, jeden kľúč odoslaný spolu s požiadavkou.
Vytvorenie kľúča
Kľúče sú v dashboarde, na obrazovke Vývojári v ponuke účtu, na jej karte API kľúče.
Projekt má vlastnú kartu API, ktorá vytvorí rovnaký druh kľúča už obmedzený na tento projekt,
takže app_id nikdy nezadávate ručne. Interaktívny sandbox API reference vám
vie kľúč vytvoriť aj hneď na mieste, takže môžete vyskúšať metódu, skôr než niečo zapojíte do
vlastného kódu.
Vytvorenie API kľúča vyžaduje overenie totožnosti, rovnakú kontrolu úrovne 2, akú Xuda žiada pred pridelením telefónneho čísla, schránky alebo prenosnej IP. Účet, v ktorom nie je nič overené, uvidí výzvu na overenie, skôr než sa otvorí formulár kľúča.
Rozsah: ako aký účet kľúč koná
Kľúč sa vytvára s jedným z troch rozsahov a vždy koná na účte alebo aplikácii, voči ktorým bol vytvorený:
- Účet: koná priamo na vašom účte, tak ako by ste konali z prihlásenej relácie dashboardu. Dosiahne každú metódu, ktorú dosiahne bežný kľúč účtu.
- Aplikácia: vytvorený z vlastnej karty API projektu, pripnutý na
app_idtohto projektu. - Plnohodnotný VPS: vydaný automaticky pri zriadení Plnohodnotného VPS, obmedzený skupinami schopností vybranými pri vytvorení. Čo to pokrýva, nájdete v časti Full Stack VPS.
Prístup: plný alebo vlastný
Každý kľúč si vyberá aj to, koľko z verejného povrchu dosiahne:
- Plný prístup: všetko, čo účet môže robiť cez API, vrátane metód pridaných po vytvorení
kľúča. Súkromné metódy zostávajú vylúčené za každých okolností:
private: trueje pevná stena, kontrolovaná pri každom volaní, nie predvolené nastavenie, ktoré plný prístup prepíše. - Vlastný prístup: výslovný zoznam povolených, ktorý zostavíte označením metód vo formulári
kľúča, zoskupený podľa mikroslužby s poľami každej metódy zobrazenými priamo. Metóda pridaná
neskôr nie je zahrnutá, kým sa nevrátite a nepovolíte ju. Metóda s
clearancepublicje dosiahnuteľná vždy, aj kľúčom s vlastným prístupom bez označenia čohokoľvek, pretože verejná metóda nepotrebuje reláciu ani položku v zozname povolených.
Metódy, ktoré vytvárajú, aktualizujú a uvádzajú API kľúče (create_account_api_key,
get_app_api_keys a zvyšok api_module), nie sú nikdy dosiahnuteľné s API kľúčom, zámerne:
prístupový údaj nemôže vytvárať ani upravovať prístupové údaje účtu, voči ktorému sa autentifikuje.
Kľúče spravujte z dashboardu alebo z prihlásenej relácie.
Odoslanie kľúča
Pri obyčajnom REST je kľúč ďalší parameter požiadavky s názvom api_key: pole v tele JSON pri
POST, parameter reťazca dopytu pri GET. Obe podoby nájdete v časti
Calling a method.
Cez MCP ide ten istý kľúč namiesto toho v hlavičke Authorization: Bearer, pole api_key
neexistuje. Pozri MCP.
API kľúč je prístupový údaj na doručiteľa: kto ho má, koná ako váš účet. Nikdy ho nevkladajte do kódu na strane klienta, nepridávajte ho do commitu ani nevkladajte do zdieľanej snímky obrazovky. Ak sa niekedy objaví na niektorom z týchto miest, kľúč okamžite nahraďte, nahradenie zachová názov a režim prístupu a starú hodnotu odvolá v tom istom kroku.