Přeskočit na obsah
Ověřeno

Přehled

Jeden endpoint, jedna obálka odpovědi a 337 metod, ke kterým má klíč API přístup.

Každá obrazovka dashboardu Xuda, každý program ve Studiu a každá integrace třetí strany volá stejné rozhraní HTTP: CPI, zkratku pro dispečer metod platformy. Existuje jeden tvar endpointu, /cpi/<method>, a jedna obálka odpovědi. Když se je naučíte jednou, pokryjete všech 337 metod, ke kterým má dnes klíč API účtu přístup.

Endpoint

POST https://xuda.ai/cpi/<method>GET  https://xuda.ai/cpi/<method>

<method> je název metody, například get_account_projects nebo dbs_read, nikdy cesta ke zdroji s id uvnitř. Každý vstup, včetně id, je parametr: u POST je to pole v těle JSON, u GET parametr řetězce dotazu (pravidla pro tělo a dotaz a příklady v cURL, JavaScriptu a Pythonu najdete v části Volání metody).

Tento web s dokumentací

Dokumentace se servíruje na xuda.ai/docs, takže sandbox na tomto webu volá /cpi/<method> ze stejného původu. Váš vlastní kód, běžící kdekoli, volá přímo https://xuda.ai/cpi/<method>.

Obálka

Každá metoda, ať uspěje, nebo selže, odpovídá stejným tvarem:

json
{ "code": 1, "data": { "...": "..." } }
  • code > 0 je úspěch. Samotné číslo nemá jiný význam než že je kladné, čtěte data.
  • code < 0 je chyba. data je obvykle textová zpráva, chyba validace k ní přidá i pole message. Kódy, podle kterých stojí za to větvit, a ty, které stačí zalogovat a ukázat, najdete v části Chyby.
  • Metoda, která vrací soubor nebo vlastní typ obsahu (export CSV, obrázek), obálku JSON přeskočí a místo toho nastaví vlastní hlavičky a tělo. To je výjimka, ne pravidlo.
  • Úspěšná odpověď nese hlavičku xu-region s názvem regionu Xuda, který volání obsloužil. Odpověď s chybou ji nenese.

Oprávnění a soukromá zeď

Každá metoda nese clearance: public, user, user_access, developer nebo admin. To je určení, kdo na ni smí přes přihlášenou relaci dashboardu: metoda public nepotřebuje nic, ostatní potřebují relaci na dané úrovni nebo vyšší.

Klíč API je samostatná zeď, ne další úroveň oprávnění. Metoda také nese příznak private. private: true je absolutní: žádný klíč API ji nemůže volat, ani ten s plným přístupem, bez ohledu na její clearance. Zhruba čtvrtina katalogu je v tomto smyslu veřejná: 337 metod ve 24 mikroslužbách, od Hlasu a Domén po Disk a authoring API Studia. Zbytek, včetně každé metody samotného api_module (metody, které vytvářejí klíče API a spravují je), zůstává jen pro relaci. Ověřování popisuje plný a vlastní přístup klíče a každý průvodce modulem níže končí živou tabulkou toho, co jeho mikroslužba zpřístupňuje.

Hledání metody

Interaktivní reference API uvádí všech 337 metod s jejich poli a umožňuje vám některou spustit proti vlastnímu účtu přímo z prohlížeče.