Siirry sisältöön
Tarkistettu

Metodin kutsuminen

POST vai GET, runko vai kyselymerkkijono ja mitä kenttien validointi odottaa.

Metodin nimi on osa URL-osoitetta. Jokainen muu syöte, myös tunnus, on parametri: JSON-rungon kenttä POST-kutsussa, kyselymerkkijonon parametri GET-kutsussa. Molemmat muodot tavoittavat saman metodin ja palauttavat saman vastausrakenteen.

POST: JSON-runko

Tavallinen muoto kaikelle, jossa on enemmän kuin pari parametria tai sisäkkäinen objekti tai taulukko.

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: kyselymerkkijono

Kätevä nopeaan tarkistukseen selaimen osoiterivistä tai curl-yksirivisestä. Palvelin jäsentää kyselymerkkijonon samaksi rungoksi, jonka metodin käsittelijä näkee, joten alla olevat säännöt ovat tärkeämpiä täällä kuin POST-kutsussa.

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

Kentän ilmoitettu tyyppi ratkaisee, miten sen kyselymerkkijonon arvo luetaan:

  • string: käytetään sellaisenaan.
  • number: ajetaan Number(...)-funktion läpi.
  • boolean: vain merkkijono true luetaan arvoksi true. Kaikki muu, mitä annat boolean-kentälle GET-kutsussa, myös false, muunnetaan tosi-arvoksi 1. Jos boolean-arvolla on merkitystä, lähetä se POST-kutsulla oikeana JSON-arvona true/false, tai jätä kyselyparametri pois, jolloin metodin oletus pysyy voimassa.
  • object / array: arvo ajetaan JSON.parse(...)-funktion läpi, joten sisäkkäisen arvon GET-kutsussa on oltava yksi kyselyparametri, joka sisältää JSON-merkkijonon (filters=%7B%22status%22%3A%22open%22%7D), ei hakasulkutyylistä kyselysisäkkäisyyttä.

Pakolliset kentät ja tyyppivirheet

Metodin jokaisella kentällä on mandatory-lippu ja type. Pakollisen kentän puuttuminen tai väärän tyypin lähettäminen POST-kutsussa (jossa mitään ei muunneta automaattisesti) palauttaa -1 ennen kuin itse metodi ajetaan:

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

Interaktiivinen API-viite listaa jokaisen metodin kentät tyyppeineen ja pakollisuuslippuineen ja antaa ajaa kutsun selaimesta, jolloin näet sen rakentaman tarkan pyynnön.

Seuraavaksi