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.
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.
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
trueest lue commetrue. Tout autre valeur passée pour un champ booléen avecGET, y comprisfalse, est convertie en1, donc vraie. Si un booléen compte, envoyez-le avecPOSTavec un vraitrue/falseJSON, 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 avecGETdoit ê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 :
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.