Hoppa till innehållet
Verifierad

Anropa en metod

POST eller GET, kropp jämfört med frågesträng och vad fältvalideraren förväntar sig.

Ett metodnamn är en del av URL:en. All annan indata, även ett id, är en parameter: ett fält i JSON-kroppen vid POST, en parameter i frågesträngen vid GET. Båda formerna når samma metod och ger samma svarsformat.

POST: en JSON-kropp

Den vanliga formen för allt med fler än ett par parametrar, eller med ett nästlat objekt eller en array.

curl -s https://xuda.ai/cpi/agent_domain_connect \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY","domain":"example.com","subdomain":"app"}'
const res = await fetch('https://xuda.ai/cpi/agent_domain_connect', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_API_KEY',
    domain: 'example.com',
    subdomain: 'app',
  }),
});
const { code, data } = await res.json();
if (code > 0) console.log(data);
import requests

res = requests.post(
    'https://xuda.ai/cpi/agent_domain_connect',
    json={'api_key': 'YOUR_API_KEY', 'domain': 'example.com', 'subdomain': 'app'},
)
body = res.json()
if body['code'] > 0:
    print(body['data'])

GET: en frågesträng

Praktiskt för en snabb kontroll från webbläsarens adressfält eller en curl-enradare. Servern tolkar frågesträngen till samma kropp som metodhanteraren ser, så reglerna nedan spelar större roll här än vid POST.

cURL
curl -s 'https://xuda.ai/cpi/agent_domain_connect?api_key=YOUR_API_KEY&domain=example.com&subdomain=app'

Ett fälts deklarerade typ avgör hur dess värde i frågesträngen läses:

  • string: används som det är.
  • number: körs genom Number(...).
  • boolean: bara den bokstavliga strängen true läses som true. Allt annat du skickar för ett boolean-fält vid GET, även false, konverteras till ett sanningsvärde 1. Om en boolean spelar roll, skicka den vid POST med ett riktigt JSON-värde true/false, eller utelämna frågeparametern så att den får metodens standardvärde.
  • object / array: värdet körs genom JSON.parse(...), så ett nästlat värde vid GET måste vara en enda frågeparameter som innehåller en JSON-sträng (filters=%7B%22status%22%3A%22open%22%7D), inte nästling i klammerstil.

Obligatoriska fält och typfel

Varje fält i en metod har en flagga mandatory och en type. Om ett obligatoriskt fält saknas, eller om fel typ skickas vid POST (där inget konverteras automatiskt), får du tillbaka en -1 innan själva metoden ens körs:

json
{ "code": -1, "data": "Error: 'domain' is a mandatory field" }
json
{ "code": -1, "data": "Error: 'domain' is a wrong type" }

Den interaktiva API reference listar varje metods fält med deras typer och obligatoriska flaggor, och låter dig köra ett anrop från webbläsaren för att se exakt vilken förfrågan det byggde.

Nästa