Aller au contenu
Vérifié

Appeler une méthode

POST ou GET, corps ou chaîne de requête, et ce qu'attend le validateur de champs.

Le nom de la méthode fait partie de l'URL. Toute autre entrée, identifiant compris, est un paramètre : un champ du corps JSON avec POST, un paramètre de chaîne de requête avec GET. Les deux formes atteignent la même méthode et renvoient la même enveloppe.

POST : un corps JSON

La forme normale pour tout ce qui a plus de quelques paramètres, ou qui contient un objet imbriqué ou un tableau.

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 : une chaîne de requête

Pratique pour une vérification rapide depuis la barre d'adresse d'un navigateur ou une commande curl d'une ligne. Le serveur analyse la chaîne de requête pour en faire le même corps que celui que voit le gestionnaire de la méthode, donc les règles ci-dessous comptent davantage ici qu'avec POST.

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

Le type déclaré d'un champ détermine comment sa valeur de chaîne de requête est lue :

  • string : utilisée telle quelle.
  • number : passée dans Number(...).
  • boolean : seule la chaîne littérale true est lue comme true. Tout autre valeur passée pour un champ booléen avec GET, y compris false, est convertie en 1, donc vraie. Si un booléen compte, envoyez-le avec POST avec un vrai true/false JSON, ou omettez simplement le paramètre de requête pour le laisser à la valeur par défaut de la méthode.
  • object / array : la valeur passe dans JSON.parse(...), donc une valeur imbriquée avec GET doit être un seul paramètre de requête contenant une chaîne JSON (filters=%7B%22status%22%3A%22open%22%7D), et non une imbrication de requête à crochets.

Champs obligatoires et erreurs de type

Les champs d'une méthode portent chacun un indicateur mandatory et un type. Oublier un champ obligatoire, ou envoyer le mauvais type avec POST (où rien n'est converti automatiquement), vous renvoie un -1 avant même que la méthode ne s'exécute :

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

La référence API interactive liste les champs de chaque méthode avec leurs types et leurs indicateurs d'obligation, et vous permet d'exécuter un appel depuis le navigateur pour voir la requête exacte qu'il a construite.

La suite