Gå til indhold
Bekræftet

Kald en metode

POST eller GET, krop versus query string, og hvad feltvalidatoren forventer.

Et metodenavn er en del af URL'en. Alt andet input, også et id, er en parameter: et felt i JSON-kroppen ved POST, en query string-parameter ved GET. Begge former når den samme metode og returnerer den samme konvolut.

POST: en JSON-krop

Den normale form til alt med mere end et par parametre eller med et indlejret objekt eller et 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 query string

Praktisk til et hurtigt tjek fra browserens adresselinje eller en curl-enlinjer. Serveren tolker query string'en til den samme krop, som metodehandleren ser, så reglerne nedenfor betyder mere her end ved POST.

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

Et felts erklærede type afgør, hvordan dets query string-værdi læses:

  • string: bruges som den er.
  • number: køres gennem Number(...).
  • boolean: kun den bogstavelige streng true læses som true. Alt andet, du sender til et boolean-felt ved GET, også false, konverteres til et sandt 1. Hvis en boolean har betydning, så send den ved POST med et rigtigt JSON-true/false, eller udelad blot query-parameteren for at lade den stå på metodens standard.
  • object / array: værdien køres gennem JSON.parse(...), så en indlejret værdi ved GET skal være én query-parameter med en JSON-streng (filters=%7B%22status%22%3A%22open%22%7D), ikke indlejring i parentesstil.

Obligatoriske felter og typefejl

Hver af en metodes felter har et mandatory-flag og en type. Hvis et obligatorisk felt mangler, eller du sender den forkerte type ved POST (hvor intet konverteres automatisk), får du et -1 tilbage, før selve metoden overhovedet kører:

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

Den interaktive API-reference viser hver metodes felter med typer og obligatoriske flag og lader dig køre et kald fra browseren for at se den præcise anmodning, den byggede.

Næste