Naar de inhoud springen
Geverifieerd

Een methode aanroepen

POST of GET, body versus querystring, en wat de veldvalidatie verwacht.

Een methodenaam is onderdeel van de URL. Elke andere invoer, ook een id, is een parameter: een JSON-bodyveld bij POST, een queryparameter bij GET. Beide vormen bereiken dezelfde methode en geven dezelfde envelop terug.

POST: een JSON-body

De normale vorm voor alles met meer dan een paar parameters, of met een geneste object of een 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: een querystring

Handig voor een snelle check vanuit de adresbalk van een browser of een curl-oneliner. De server parseert de querystring tot dezelfde body die de methodehandler ziet, dus de regels hieronder zijn hier belangrijker dan bij POST.

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

Het gedeclareerde type van een veld bepaalt hoe de waarde in de querystring wordt gelezen:

  • string: ongewijzigd gebruikt.
  • number: door Number(...) gehaald.
  • boolean: alleen de letterlijke string true wordt gelezen als true. Al het andere wat je voor een booleanveld meegeeft bij GET, ook false, wordt omgezet naar een waarachtige 1. Als een boolean ertoe doet, stuur hem dan bij POST met een echte JSON-true/false, of laat de queryparameter weg om de standaardwaarde van de methode te houden.
  • object / array: de waarde wordt door JSON.parse(...) gehaald, dus een geneste waarde bij GET moet één queryparameter zijn met een JSON-string (filters=%7B%22status%22%3A%22open%22%7D), geen geneste query in haakjesstijl.

Verplichte velden en typefouten

De velden van een methode hebben elk een vlag mandatory en een type. Mist er een verplicht veld, of stuur je bij POST (waar niets automatisch wordt omgezet) het verkeerde type, dan krijg je een -1 terug voordat de methode zelf ooit draait:

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

De interactieve API-referentie toont de velden van elke methode met hun typen en vlaggen voor verplicht, en laat je een aanroep vanuit de browser uitvoeren om het exacte verzoek te zien dat is opgebouwd.

Volgende