Oversikt
Ett endepunkt, én svarkonvolutt og de 337 metodene en API-nøkkel kan nå.
Hver skjerm i Xuda-dashbordet, hvert Studio-program og hver tredjepartsintegrasjon kaller den
samme HTTP-flaten: CPI, kort for plattformens metodeformidler. Det finnes én endepunktform,
/cpi/<method>, og én svarkonvolutt. Når du har lært den én gang, dekker det alle 337 metodene en
API-nøkkel for kontoen kan nå i dag.
Endepunktet
<method> er et metodenavn som get_account_projects eller dbs_read, aldri en ressursbane med
en id i. Alle inndata, også en id, er parametere: ved POST er det et felt i en JSON-kropp, ved
GET er det en spørrestrengparameter (se Å kalle en metode for reglene
om kropp mot spørrestreng og gjennomgåtte eksempler i cURL, JavaScript og Python).
Dokumentasjonen serveres på xuda.ai/docs, så sandkassen på dette nettstedet kaller /cpi/<method>
fra samme opprinnelse. Din egen kode, som kjører hvor som helst, kaller https://xuda.ai/cpi/<method>
direkte.
Konvolutten
Hver metode, enten den lykkes eller feiler, svarer med samme form:
code > 0er suksess. Selve tallet har ingen betydning utover at det er positivt, lesdata.code < 0er en feil.dataer vanligvis en meldingsstreng. En valideringsfeil legger også til etmessage-felt utledet fra den. Se Feil for kodene det er verdt å forgrene på, og de du bare bør logge og vise.- En metode som returnerer en fil eller en egendefinert innholdstype (en CSV-eksport, et bilde) hopper over JSON-konvolutten og setter sine egne overskrifter og sin egen kropp i stedet. Det er unntaket, ikke regelen.
- Et vellykket svar har en
xu-region-overskrift som navngir Xuda-regionen som håndterte kallet. Et feilsvar har den ikke.
Klarering og den private muren
Hver metode har en clearance: public, user, user_access, developer eller admin. Dette
er hvem som kan nå den over en innlogget dashbordøkt: en public-metode trenger ingenting, de
andre trenger en økt på det nivået eller høyere.
En API-nøkkel er en egen mur, ikke en ny klarering. En metode har også et private-flagg.
private: true er absolutt: ingen API-nøkkel kan kalle den, ikke engang en med full tilgang,
uansett klarering. Omtrent en fjerdedel av katalogen er offentlig i den forstand: 337 metoder fordelt
på 24 mikrotjenester, som spenner fra Voice og Domener til Drive og Studios authoring-API. Resten,
inkludert hver metode i selve api_module (metodene som oppretter og administrerer API-nøkler),
forblir kun for økter. Autentisering beskriver full mot egendefinert
nøkkeltilgang, og hver modulveiledning nedenfor avsluttes med den live tabellen over hva
mikrotjenesten eksponerer.
Å finne en metode
Den interaktive API-referansen lister alle 337 metodene med feltene deres, og lar deg kjøre en mot din egen konto rett fra nettleseren.