Přeskočit na obsah
Ověřeno

Volání metody

POST nebo GET, tělo nebo řetězec dotazu a co očekává validátor polí.

Název metody je součástí URL. Každý další vstup, včetně id, je parametr: pole těla JSON u POST, parametr řetězce dotazu u GET. Obě podoby míří na stejnou metodu a vrací stejnou obálku.

POST: tělo JSON

Běžný tvar pro cokoli, co má víc než pár parametrů nebo vnořený objekt či pole.

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: řetězec dotazu

Šikovné pro rychlou kontrolu z adresního řádku prohlížeče nebo jednořádkový curl. Server zpracuje řetězec dotazu do stejného těla, které vidí obsluha metody, takže pravidla níže tu záleží víc než u POST.

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

O tom, jak se hodnota z řetězce dotazu přečte, rozhoduje deklarovaný typ pole:

  • string: použije se tak, jak je.
  • number: projde přes Number(...).
  • boolean: jen doslovný řetězec true se čte jako true. Cokoli jiného, co u pole boolean předáte přes GET, včetně false, se převede na pravdivé 1. Pokud na hodnotě boolean záleží, pošlete ji přes POST se skutečným JSON true/false, nebo parametr dotazu prostě vynechte, aby zůstal na výchozí hodnotě metody.
  • object / array: hodnota projde přes JSON.parse(...), takže vnořená hodnota u GET musí být jeden parametr dotazu s řetězcem JSON (filters=%7B%22status%22%3A%22open%22%7D), ne vnořování v závorkách.

Povinná pole a chyby typu

Každé pole metody nese příznak mandatory a type. Chybějící povinné pole nebo špatný typ poslaný přes POST (kde se nic automaticky nepřetypovává) vám vrátí -1 dřív, než se metoda vůbec spustí:

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

Interaktivní reference API uvádí pole každé metody s jejich typy a příznaky povinnosti a umožňuje spustit volání z prohlížeče, abyste viděli přesný požadavek, který sestavilo.

Dál