Áttekintés
Egy végpont, egy válaszburkoló, és a 337 metódus, amelyet egy API-kulcs elérhet.
A Xuda irányítópultjának minden képernyője, minden Studio-program és minden harmadik fél integrációja
ugyanazt a HTTP-felületet hívja: a CPI-t, a platform metódusirányítójának rövidítését. Egyetlen
végpontforma van, /cpi/<method>, és egyetlen válaszburkoló. Egyszeri megtanulása mind a 337 metódust lefedi,
amelyet egy fiók API-kulcsa ma elérhet.
A végpont
A <method> egy metódusnév, például get_account_projects vagy dbs_read, soha nem azonosítót tartalmazó
erőforrásútvonal. Minden bemenet, az azonosító is, paraméter: POST esetén egy mező a JSON-törzsben, GET
esetén egy lekérdezési karakterlánc-paraméter (a törzs és a lekérdezés szabályairól, valamint cURL-lel,
JavaScripttel és Pythonnal kidolgozott példákról lásd a Metódus hívása oldalt).
A dokumentáció az xuda.ai/docs címen érhető el, így az ezen az oldalon lévő homokozó a /cpi/<method>
végpontot azonos eredetből hívja. Az Ön saját kódja, bárhol fut, közvetlenül a https://xuda.ai/cpi/<method>
címet hívja.
A burkoló
Minden metódus, sikerrel vagy hibával, ugyanazzal az alakkal válaszol:
- A
code > 0siker. Maga a szám nem hordoz jelentést a pozitivitáson túl, olvassa adatamezőt. - A
code < 0hiba. Adataáltalában üzenetszöveg, az érvényesítési hiba egy abból származtatottmessagemezőt is hozzáad. Az elágazásra érdemes kódokat és azokat, amelyeket elég naplózni és megjeleníteni, lásd a Hibák oldalon. - A fájlt vagy egyéni tartalomtípust (CSV-exportot, képet) visszaadó metódus kihagyja a JSON-burkolót, és helyette saját fejlécet és törzset állít be. Ez a kivétel, nem a szabály.
- A sikeres válasz egy
xu-regionfejlécet hordoz, amely a hívást kezelő Xuda-régiót nevezi meg. A hibaválasz nem hordozza.
Jogosultsági szint és a privát fal
Minden metódus hordoz egy clearance értéket: public, user, user_access, developer vagy admin. Ez
azt mondja meg, ki érheti el bejelentkezett irányítópult-munkamenettel: a public metódushoz semmi sem
kell, a többihez ezen a szinten vagy fölötte lévő munkamenet.
Az API-kulcs külön fal, nem egy másik jogosultsági szint. A metódus egy private jelzőt is hordoz. A
private: true abszolút: semmilyen API-kulcs nem hívhatja, a teljes hozzáférésű sem, a jogosultsági szintjétől
függetlenül. A katalógus nagyjából negyede ebben az értelemben nyilvános: 337 metódus 24
mikroszolgáltatásban, a Voice-tól és a Domains-től a Drive-ig és a Studio szerzői API-ig mindent átfogva. A
többi, beleértve az api_module minden metódusát (az API-kulcsokat létrehozó és kezelő metódusokat), csak
munkamenettel érhető el. A Hitelesítés a teljes és az egyéni kulcshozzáférést
tárgyalja, és az alábbi minden modulútmutató a mikroszolgáltatása által kínált metódusok élő táblázatával
zárul.
Metódus keresése
Az interaktív API-referencia mind a 337 metódust listázza a mezőikkel, és lehetővé teszi, hogy közvetlenül a böngészőből futtasson egyet a saját fiókján.