Sari la conținut
Verificat

Apelarea unei metode

POST sau GET, corp față de șir de interogare și ce așteaptă validatorul de câmpuri.

Numele unei metode face parte din URL. Fiecare altă intrare, inclusiv un id, este un parametru: un câmp din corpul JSON la POST, un parametru de șir de interogare la GET. Ambele forme ajung la aceeași metodă și returnează același plic.

POST: un corp JSON

Forma obișnuită pentru orice are mai mult de câțiva parametri sau un obiect imbricat ori un 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: un șir de interogare

Util pentru o verificare rapidă din bara de adrese a browserului sau cu un curl pe o singură linie. Serverul interpretează șirul de interogare în același corp pe care îl vede handlerul metodei, așa că regulile de mai jos contează mai mult aici decât la POST.

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

Tipul declarat al unui câmp decide cum este citită valoarea lui din șirul de interogare:

  • string: folosită ca atare.
  • number: trecută prin Number(...).
  • boolean: doar șirul literal true este citit ca true. Orice altceva transmiți pentru un câmp boolean la GET, inclusiv false, este convertit la un 1 evaluat ca adevărat. Dacă un boolean contează, trimite-l la POST cu un true/false JSON real sau omite pur și simplu parametrul de interogare, ca să rămână la valoarea implicită a metodei.
  • object / array: valoarea este trecută prin JSON.parse(...), așa că o valoare imbricată la GET trebuie să fie un parametru de interogare care conține un șir JSON (filters=%7B%22status%22%3A%22open%22%7D), nu o imbricare în stil paranteze în interogare.

Câmpuri obligatorii și erori de tip

Fiecare câmp al unei metode are un indicator mandatory și un type. Dacă lipsește un câmp obligatoriu sau trimiți tipul greșit la POST (unde nu se convertește nimic automat), primești înapoi un -1 înainte ca metoda însăși să ruleze:

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

Referința API interactivă listează câmpurile fiecărei metode cu tipurile și indicatorii lor obligatorii și te lasă să rulezi un apel din browser, ca să vezi cererea exactă pe care a construit-o.

Mai departe