Hopp til innholdet
Bekreftet

Å kalle en metode

POST eller GET, kropp mot spørrestreng, og hva feltvalidatoren forventer.

Et metodenavn er en del av URL-en. Alle andre inndata, også en id, er parametere: et JSON-kroppsfelt ved POST, en spørrestrengparameter ved GET. Begge formene når samme metode og gir samme konvolutt tilbake.

POST: en JSON-kropp

Den vanlige formen for alt med mer enn et par parametere, eller med et nestet objekt eller en matrise.

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 spørrestreng

Praktisk for en rask sjekk fra adressefeltet i en nettleser eller en curl-enlinjer. Serveren tolker spørrestrengen til den samme kroppen metodebehandleren ser, så reglene nedenfor betyr mer her enn ved POST.

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

Et felts deklarerte type avgjør hvordan spørrestrengverdien leses:

  • string: brukes som den er.
  • number: kjøres gjennom Number(...).
  • boolean: bare den bokstavelige strengen true leses som true. Alt annet du sender for et boolean-felt ved GET, også false, tvinges til en sann 1. Hvis en boolean betyr noe, send den ved POST med en ekte JSON true/false, eller utelat spørreparameteren for å la den stå på metodens standard.
  • object / array: verdien kjøres gjennom JSON.parse(...), så en nestet verdi ved GET må være én spørreparameter som inneholder en JSON-streng (filters=%7B%22status%22%3A%22open%22%7D), ikke nesting i parentesstil.

Obligatoriske felt og typefeil

Hvert felt i en metode har et mandatory-flagg og en type. Mangler et obligatorisk felt, eller sender du feil type ved POST (der ingenting tvinges automatisk), får du en -1 tilbake før selve metoden i det hele tatt kjører:

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

Den interaktive API-referansen lister hver metodes felt med typer og obligatoriske flagg, og lar deg kjøre et kall fra nettleseren for å se nøyaktig hvilken forespørsel den bygde.

Neste