Översikt
En enda slutpunkt, ett enda svarsformat och de 337 metoder som en API-nyckel kan nå.
Varje skärm i Xuda-dashboarden, varje Studio-program och varje tredjepartsintegration anropar
samma HTTP-yta: CPI, förkortning för plattformens metodavsändare. Det finns en enda form på
slutpunkten, /cpi/<method>, och ett enda svarsformat. Lär du dig det en gång täcker det alla 337
metoder som en API-nyckel för kontot kan nå i dag.
Slutpunkten
<method> är ett metodnamn som get_account_projects eller dbs_read, aldrig en resurssökväg med
ett id i. All indata, även ett id, är en parameter: vid POST är den ett fält i en JSON-kropp, vid
GET en parameter i frågesträngen (se Calling a method för reglerna om
kropp mot frågesträng och genomgångna exempel i cURL, JavaScript och Python).
Dokumentationen serveras på xuda.ai/docs, så sandlådan på den här sajten anropar /cpi/<method>
på samma ursprung. Din egen kod, var den än körs, anropar https://xuda.ai/cpi/<method> direkt.
Svarsformatet
Varje metod, vid framgång eller fel, svarar med samma form:
code > 0är framgång. Själva talet har ingen betydelse utöver att vara positivt, läsdata.code < 0är ett fel.dataär oftast en meddelandesträng. Ett valideringsfel lägger också till ett fältmessagesom härleds från den. Se Errors för de koder som är värda att förgrena på och de som du bara ska logga och visa.- En metod som returnerar en fil eller en egen innehållstyp (en CSV-export, en bild) hoppar över JSON-formatet och sätter sina egna rubriker och sin egen kropp i stället. Det är undantaget, inte regeln.
- Ett lyckat svar har en rubrik
xu-regionsom anger vilken Xuda-region som hanterade anropet. Ett felsvar har den inte.
Behörighetsnivå och den privata muren
Varje metod har en clearance: public, user, user_access, developer eller admin. Det
anger vem som får nå den via en inloggad dashboardsession: en public-metod kräver ingenting,
övriga kräver en session på den nivån eller högre.
En API-nyckel är en separat mur, inte ytterligare en behörighetsnivå. En metod har också en
flagga private. private: true är absolut: ingen API-nyckel kan anropa den, inte ens en med full
åtkomst, oavsett dess behörighetsnivå. Ungefär en fjärdedel av katalogen är offentlig i den
meningen: 337 metoder i 24 mikrotjänster, som spänner från Voice och Domains till Drive och
Studios API för att skapa program. Resten, inklusive varje metod i själva api_module (metoderna
som skapar och hanterar API-nycklar), förblir bara tillgängliga via session.
Authentication beskriver full jämfört med anpassad nyckelåtkomst, och varje
modulguide nedan slutar med den levande tabellen över vad dess mikrotjänst exponerar.
Hitta en metod
Den interaktiva API reference listar alla 337 metoder med deras fält och låter dig köra en mot ditt eget konto direkt från webbläsaren.