Siirry sisältöön
Tarkistettu

Yleiskatsaus

Yksi päätepiste, yksi vastausrakenne ja 337 metodia, joihin API-avain yltää.

Jokainen Xuda-dashboardin näyttö, jokainen Studio-ohjelma ja jokainen kolmannen osapuolen integraatio kutsuu samaa HTTP-rajapintaa: CPI, lyhenne alustan metodien jakajasta. Päätepisteen muoto on yksi, /cpi/<method>, ja vastausrakenne on yksi. Kun opit sen kerran, hallitset kaikki 337 metodia, joihin tilin API-avain tällä hetkellä yltää.

Päätepiste

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

<method> on metodin nimi, kuten get_account_projects tai dbs_read, ei koskaan resurssipolku, jossa on tunnus. Jokainen syöte, myös tunnus, on parametri: POST-kutsussa se on kenttä JSON-rungossa, GET-kutsussa kyselymerkkijonon parametri (katso rungon ja kyselyn säännöt sekä esimerkit cURL:llä, JavaScriptillä ja Pythonilla sivulta Metodin kutsuminen).

Tämä dokumentaatiosivusto

Dokumentaatio tarjoillaan osoitteessa xuda.ai/docs, joten tämän sivuston hiekkalaatikko kutsuu /cpi/<method> samasta alkuperästä. Oma koodisi, missä tahansa se onkaan käynnissä, kutsuu suoraan osoitetta https://xuda.ai/cpi/<method>.

Vastausrakenne

Jokainen metodi vastaa onnistuessaan tai epäonnistuessaan samalla rakenteella:

json
{ "code": 1, "data": { "...": "..." } }
  • code > 0 on onnistuminen. Luvulla itsellään ei ole muuta merkitystä kuin että se on positiivinen, lue data.
  • code < 0 on virhe. data on yleensä viestimerkkijono. Validointivirhe lisää myös siitä johdetun message-kentän. Katso Virheet, mitkä koodit kannattaa haaroittaa ja mitkä vain kirjata ja näyttää.
  • Metodi, joka palauttaa tiedoston tai mukautetun sisältötyypin (CSV-vienti, kuva), ohittaa JSON-rakenteen ja asettaa omat otsikkonsa ja runkonsa. Se on poikkeus, ei sääntö.
  • Onnistunut vastaus sisältää xu-region-otsikon, joka nimeää kutsun käsitelleen Xuda-alueen. Virhevastauksessa sitä ei ole.

Valtuustaso ja yksityinen muuri

Jokaisella metodilla on clearance: public, user, user_access, developer tai admin. Se kertoo, kuka sen tavoittaa kirjautuneella dashboard-istunnolla: public-metodi ei vaadi mitään, muut vaativat istunnon vähintään kyseisellä tasolla.

API-avain on erillinen muuri, ei toinen valtuustaso. Metodilla on myös private-lippu. private: true on ehdoton: mikään API-avain ei voi kutsua sitä, ei edes täyden käyttöoikeuden avain, valtuustasosta riippumatta. Noin neljännes luettelosta on tässä mielessä julkista: 337 metodia 24 mikropalvelussa, Äänestä ja Verkkotunnuksista Driveen ja Studion kirjoitus-API:in. Loput, mukaan lukien jokainen api_module-metodi itse (API-avaimia luovat ja hallitsevat metodit), ovat vain istunnolle. Todennus kertoo täyden ja mukautetun avainkäyttöoikeuden eron, ja jokainen alla oleva moduulin opas päättyy elävään taulukkoon siitä, mitä sen mikropalvelu tarjoaa.

Metodin löytäminen

Interaktiivinen API-viite listaa kaikki 337 metodia kenttineen ja antaa ajaa yhden omalla tililläsi suoraan selaimesta.