Saltar al contenido
Verificada

Llamar a un método

POST o GET, cuerpo frente a cadena de consulta, y qué espera el validador de campos.

El nombre del método forma parte de la URL. Cualquier otra entrada, incluido un id, es un parámetro: un campo del cuerpo JSON en POST, un parámetro de la cadena de consulta en GET. Ambas formas llegan al mismo método y devuelven el mismo sobre.

POST: un cuerpo JSON

La forma normal para cualquier cosa con más de un par de parámetros, o con un objeto anidado o 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: una cadena de consulta

Práctico para una comprobación rápida desde la barra de direcciones del navegador o con una línea de curl. El servidor convierte la cadena de consulta en el mismo cuerpo que ve el manejador del método, así que las reglas de abajo importan más aquí que en POST.

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

El tipo declarado de un campo decide cómo se lee su valor en la cadena de consulta:

  • string: se usa tal cual.
  • number: pasa por Number(...).
  • boolean: solo la cadena literal true se lee como true. Cualquier otra cosa que pases para un campo booleano en GET, incluido false, se convierte en un 1 verdadero. Si un booleano importa, envíalo en POST con un true/false JSON real, o simplemente omite el parámetro de consulta para dejarlo en el valor por defecto del método.
  • object / array: el valor pasa por JSON.parse(...), así que un valor anidado en GET tiene que ser un parámetro de consulta que contenga una cadena JSON (filters=%7B%22status%22%3A%22open%22%7D), no un anidado de consulta al estilo de corchetes.

Campos obligatorios y errores de tipo

Cada campo de un método lleva una marca mandatory y un type. Si falta un campo obligatorio, o se envía un tipo incorrecto en POST (donde nada se convierte automáticamente), recibes un -1 antes de que el método llegue a ejecutarse:

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

La referencia de la API interactiva lista los campos de cada método con sus tipos y marcas de obligatorio, y te permite ejecutar una llamada desde el navegador para ver la solicitud exacta que construyó.

Siguiente