Preskočiť na obsah
Overené

Prehľad

Jeden koncový bod, jedna obálka odpovede a 337 metód, ktoré API kľúč dosiahne.

Každá obrazovka v dashboarde Xuda, každý program v Studiu a každá integrácia tretej strany volá ten istý povrch HTTP: CPI, skratku pre dispečer metód platformy. Existuje jeden tvar koncového bodu, /cpi/<method>, a jedna obálka odpovede. Naučiť sa ich raz pokrýva všetkých 337 metód, ktoré dnes API kľúč účtu dosiahne.

Koncový bod

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

<method> je názov metódy, napríklad get_account_projects alebo dbs_read, nikdy nie cesta k zdroju s id v nej. Každý vstup, aj id, je parameter: pri POST je to pole v tele JSON, pri GET parameter reťazca dopytu (pravidlá telo oproti dopytu a vypracované príklady v cURL, JavaScripte a Pythone nájdete v časti Calling a method).

Táto stránka s dokumentáciou

Dokumentácia sa poskytuje na xuda.ai/docs, takže sandbox na tejto stránke volá /cpi/<method> v rámci toho istého pôvodu. Váš vlastný kód, bežiaci kdekoľvek, volá priamo https://xuda.ai/cpi/<method>.

Obálka

Každá metóda, úspešná či neúspešná, odpovedá rovnakým tvarom:

json
{ "code": 1, "data": { "...": "..." } }
  • code > 0 je úspech. Samotné číslo nemá okrem toho, že je kladné, žiadny význam, čítajte data.
  • code < 0 je chyba. data je zvyčajne textová správa. Zlyhanie validácie pridá aj pole message odvodené z nej. Kódy, na ktoré sa oplatí vetviť, a tie, ktoré stačí zapísať a zobraziť, nájdete v časti Errors.
  • Metóda, ktorá vracia súbor alebo vlastný typ obsahu (export CSV, obrázok), obálku JSON preskočí a nastaví vlastné hlavičky a telo. To je výnimka, nie pravidlo.
  • Úspešná odpoveď nesie hlavičku xu-region s názvom regiónu Xuda, ktorý volanie spracoval. Odpoveď s chybou ju nenesie.

Oprávnenie a súkromná stena

Každá metóda nesie clearance: public, user, user_access, developer alebo admin. To je, kto sa k nej môže dostať cez prihlásenú reláciu dashboardu: metóda public nevyžaduje nič, ostatné vyžadujú reláciu na tejto úrovni alebo vyššie.

API kľúč je samostatná stena, nie ďalšie oprávnenie. Metóda nesie aj príznak private. private: true je absolútny: žiadny API kľúč ju nemôže volať, ani s plným prístupom, bez ohľadu na jej oprávnenie. Približne štvrtina katalógu je verejná v tomto zmysle: 337 metód v 24 mikroslužbách, od Voice a Domains po Drive a API na tvorbu v Studiu. Zvyšok, vrátane každej metódy v samotnom api_module (metódy, ktoré vytvárajú a spravujú API kľúče), zostáva len pre reláciu. Authentication popisuje plný a vlastný prístup kľúča a každý sprievodca modulom nižšie končí živou tabuľkou toho, čo jeho mikroslužba sprístupňuje.

Hľadanie metódy

Interaktívna API reference uvádza všetkých 337 metód s ich poľami a umožňuje spustiť ktorúkoľvek voči vlastnému účtu priamo z prehliadača.