Sari la conținut
Verificat

Prezentare generală

Un singur endpoint, un singur plic de răspuns și cele 337 de metode la care ajunge o cheie API.

Fiecare ecran din dashboardul Xuda, fiecare program Studio și fiecare integrare terță apelează aceeași suprafață HTTP: CPI, prescurtarea de la dispecerul de metode al platformei. Există o singură formă de endpoint, /cpi/<method>, și un singur plic de răspuns. Odată învățat, acoperă toate cele 337 de metode la care poate ajunge astăzi o cheie API de cont.

Endpointul

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

<method> este un nume de metodă precum get_account_projects sau dbs_read, niciodată o cale de resursă care conține un id. Fiecare intrare, inclusiv un id, este un parametru: la POST este un câmp într-un corp JSON, la GET este un parametru de șir de interogare (vezi Apelarea unei metode pentru regulile corp față de interogare și exemple în cURL, JavaScript și Python).

Acest site de documentație

Documentația este servită la xuda.ai/docs, așa că sandboxul de pe acest site apelează /cpi/<method> pe aceeași origine. Codul tău, rulând oriunde, apelează direct https://xuda.ai/cpi/<method>.

Plicul de răspuns

Fiecare metodă, cu succes sau cu eșec, răspunde în aceeași formă:

json
{ "code": 1, "data": { "...": "..." } }
  • code > 0 înseamnă succes. Numărul în sine nu are alt sens decât că este pozitiv, citește data.
  • code < 0 este o eroare. data este de obicei un mesaj text; o eroare de validare adaugă și un câmp message derivat din el. Vezi Erori pentru codurile pe care merită să ramifici logica și pe cele pe care ar trebui doar să le înregistrezi și să le afișezi.
  • O metodă care returnează un fișier sau un tip de conținut personalizat (un export CSV, o imagine) sare peste plicul JSON și își setează propriile anteturi și corp. Aceasta este excepția, nu regula.
  • Un răspuns reușit poartă un antet xu-region care numește regiunea Xuda care a tratat apelul. Un răspuns de eroare nu îl poartă.

Clearance și zidul privat

Fiecare metodă are un clearance: public, user, user_access, developer sau admin. Acesta arată cine poate ajunge la ea printr-o sesiune de dashboard autentificată: o metodă public nu cere nimic, celelalte cer o sesiune cel puțin la acel nivel.

O cheie API este un zid separat, nu un alt clearance. O metodă are și un indicator private. private: true este absolut: nicio cheie API nu o poate apela, nici măcar una cu acces complet, indiferent de clearance. Aproximativ un sfert din catalog este public în acest sens: 337 de metode în 24 de microservicii, de la Voice și Domains până la Drive și API-ul de creare din Studio. Restul, inclusiv fiecare metodă din api_module însuși (metodele care creează și gestionează cheile API), rămân doar pentru sesiune. Autentificarea explică accesul complet față de cel personalizat al unei chei, iar fiecare ghid de modul de mai jos se încheie cu tabelul live al ceea ce expune microserviciul său.

Găsirea unei metode

Referința API interactivă listează toate cele 337 de metode cu câmpurile lor și te lasă să rulezi una pe propriul cont direct din browser.