Gå til indhold
Bekræftet

Overblik

Ét endpoint, én svarkonvolut og de 337 metoder, en API-nøgle kan nå.

Hver skærm i Xuda-dashboardet, hvert Studio-program og hver tredjepartsintegration kalder den samme HTTP-flade: CPI, kort for platformens metodedispatcher. Der er én endpoint-form, /cpi/<method>, og én svarkonvolut. Når du har lært den én gang, dækker det alle 337 metoder, en konto-API-nøgle kan nå i dag.

Endpointet

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

<method> er et metodenavn som get_account_projects eller dbs_read, aldrig en ressourcesti med et id i. Alt input, også et id, er en parameter: ved POST er det et felt i en JSON-krop, ved GET en query string-parameter (se Kald en metode for reglerne om krop versus forespørgsel og eksempler i cURL, JavaScript og Python).

Dette dokumentationssted

Dokumentationen serveres på xuda.ai/docs, så sandkassen på dette sted kalder /cpi/<method> på samme oprindelse. Din egen kode, uanset hvor den kører, kalder https://xuda.ai/cpi/<method> direkte.

Konvolutten

Hver metode, uanset om den lykkes eller fejler, svarer med den samme form:

json
{ "code": 1, "data": { "...": "..." } }
  • code > 0 er succes. Selve tallet har ingen betydning ud over at være positivt, læs data.
  • code < 0 er en fejl. data er som regel en beskedstreng. En valideringsfejl tilføjer også et message-felt afledt af den. Se Fejl for de koder, det er værd at forgrene på, og dem, du bare skal logge og vise.
  • En metode, der returnerer en fil eller en brugerdefineret indholdstype (en CSV-eksport, et billede), springer JSON-konvolutten over og sætter sine egne headere og sin egen krop. Det er undtagelsen, ikke reglen.
  • Et vellykket svar har en xu-region-header, der navngiver den Xuda-region, som håndterede kaldet. Et fejlsvar har den ikke.

Clearance og den private mur

Hver metode har en clearance: public, user, user_access, developer eller admin. Det er, hvem der må nå den via en logget ind dashboard-session: en public metode kræver intet, resten kræver en session på det niveau eller derover.

En API-nøgle er en separat mur, ikke endnu en clearance. En metode har også et private-flag. private: true er absolut: ingen API-nøgle kan kalde den, ikke engang en med fuld adgang, uanset dens clearance. Cirka en fjerdedel af kataloget er offentligt i den forstand: 337 metoder fordelt på 24 mikrotjenester, fra Voice og Domains til Drive og Studios forfatter-API. Resten, inklusive hver metode på selve api_module (metoderne, der opretter og administrerer API-nøgler), er kun til sessioner. Autentificering beskriver fuld versus brugerdefineret nøgleadgang, og hver modulvejledning nedenfor slutter med den levende tabel over, hvad dens mikrotjeneste udstiller.

Find en metode

Den interaktive API-reference viser alle 337 metoder med deres felter og lader dig køre én mod din egen konto direkte fra browseren.