Ověřování
Klíče API účtu, plný a vlastní přístup a kde klíč vytvořit.
Každé volání CPI nese klíč API. Neexistuje samostatné id klienta, handshake OAuth ani podpis, který by se musel počítat: jeden klíč, poslaný s požadavkem.
Vytvoření klíče
Klíče žijí v dashboardu, na obrazovce Vývojáři v nabídce účtu, na její kartě Klíče API.
Projekt má vlastní kartu API, která vytvoří stejný druh klíče rovnou omezený na daný projekt,
takže app_id nikdy nezadáváte ručně. Interaktivní sandbox reference API vám
také umí klíč vytvořit na místě, takže si můžete metodu vyzkoušet dřív, než cokoli zapojíte do
vlastního kódu.
Vytvoření klíče API vyžaduje ověření totožnosti, stejnou kontrolu úrovně 2, jakou Xuda požaduje před vydáním telefonního čísla, poštovní schránky nebo přenosné IP adresy. Účet, který nemá nic ověřeno, uvidí výzvu k ověření dřív, než se otevře formulář klíče.
Rozsah: jako jaký účet klíč jedná
Klíč se vytváří s jedním ze tří rozsahů a vždy jedná na účtu nebo aplikaci, proti které vznikl:
- Účet: jedná přímo na vašem účtu, jako byste byli v přihlášené relaci dashboardu. Dosáhne na každou metodu, kterou může běžný klíč účtu.
- Aplikace: vytvořený na vlastní kartě API projektu, připnutý k
app_iddaného projektu. - Full-stack VPS: vydává se automaticky při zřízení Full-stack VPS, omezený skupinami schopností zvolenými při vytvoření. Co to pokrývá, viz Full-stack VPS.
Přístup: plný, nebo vlastní
Každý klíč také volí, jak velkou část veřejného rozhraní může použít:
- Plný přístup: vše, co účet může dělat přes API, včetně metod přidaných po vytvoření klíče.
Soukromé metody zůstávají vyloučené za všech okolností:
private: trueje pevná zeď, kontrolovaná při každém volání, ne výchozí hodnota, kterou plný přístup přebije. - Vlastní přístup: výslovný seznam povolených metod, který sestavíte zaškrtáváním metod ve
formuláři klíče, seskupených podle mikroslužby s poli každé metody zobrazenými přímo. Metoda
přidaná později se nezahrne, dokud se nevrátíte a nepovolíte ji. Metoda, jejíž
clearancejepublic, je dostupná vždy, i vlastnímu klíči s nic nezaškrtnutým, protože veřejná metoda nepotřebuje relaci ani položku v seznamu.
Metody, které vytvářejí, mění a vypisují klíče API (create_account_api_key, get_app_api_keys a
zbytek api_module), nejsou s klíčem API dostupné nikdy, záměrně: přihlašovací údaj nemůže
vytvářet ani upravovat přihlašovací údaje účtu, ke kterému se ověřuje. Klíče spravujte z
dashboardu nebo z přihlášené relace.
Odeslání klíče
Přes prosté REST je klíč dalším parametrem požadavku s názvem api_key: pole v těle JSON u POST,
parametr řetězce dotazu u GET. Obě podoby viz Volání metody.
Přes MCP jde stejný klíč místo toho v hlavičce Authorization: Bearer, pole api_key neexistuje.
Viz MCP.
Klíč API je přihlašovací údaj na doručitele: kdo ho má, jedná jako váš účet. Nikdy ho neposílejte v kódu na straně klienta, nekomitujte ho ani nevkládejte do sdíleného snímku obrazovky. Pokud se někdy objeví na některém z těchto míst, klíč ihned nahraďte, nahrazení zachová název a režim přístupu a starou hodnotu odvolá ve stejném kroku.