Preskočiť na obsah
Overené

Calling a method

POST alebo GET, telo oproti reťazcu dopytu a čo očakáva validátor polí.

Názov metódy je súčasťou adresy URL. Každý ďalší vstup, aj id, je parameter: pole v tele JSON pri POST, parameter reťazca dopytu pri GET. Obe podoby dosiahnu tú istú metódu a vrátia tú istú obálku.

POST: telo JSON

Bežný tvar pre všetko s viac než niekoľkými parametrami alebo s vnoreným objektom či poľom.

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: reťazec dopytu

Praktický na rýchlu kontrolu z adresného riadka prehliadača alebo jednoriadkový curl. Server spracuje reťazec dopytu do rovnakého tela, aké vidí obsluha metódy, takže nižšie uvedené pravidlá sú tu dôležitejšie než pri POST.

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

O tom, ako sa hodnota reťazca dopytu číta, rozhoduje deklarovaný typ poľa:

  • string: použije sa tak, ako je.
  • number: prejde cez Number(...).
  • boolean: len doslovný reťazec true sa číta ako true. Čokoľvek iné, čo pri GET zadáte do poľa boolean, vrátane false, sa pretypuje na pravdivé 1. Ak na hodnote boolean záleží, pošlite ju cez POST so skutočným JSON true/false, alebo parameter dopytu jednoducho vynechajte, aby zostal na predvolenej hodnote metódy.
  • object / array: hodnota prejde cez JSON.parse(...), takže vnorená hodnota pri GET musí byť jeden parameter dopytu s reťazcom JSON (filters=%7B%22status%22%3A%22open%22%7D), nie vnorenie v štýle zátvoriek.

Povinné polia a chyby typu

Polia metódy majú každé príznak mandatory a type. Chýbajúce povinné pole alebo odoslanie nesprávneho typu pri POST (kde sa nič automaticky nepretypúva) vám vráti -1 skôr, než sa samotná metóda vôbec spustí:

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

Interaktívna API reference uvádza polia každej metódy s ich typmi a príznakmi povinnosti a umožňuje spustiť volanie z prehliadača, aby ste videli presnú požiadavku, ktorú zostavilo.

Ďalej