Apelarea unei metode
POST sau GET, corp față de șir de interogare și ce așteaptă validatorul de câmpuri.
Numele unei metode face parte din URL. Fiecare altă intrare, inclusiv un id, este un parametru: un
câmp din corpul JSON la POST, un parametru de șir de interogare la GET. Ambele forme ajung la
aceeași metodă și returnează același plic.
POST: un corp JSON
Forma obișnuită pentru orice are mai mult de câțiva parametri sau un obiect imbricat ori un array.
GET: un șir de interogare
Util pentru o verificare rapidă din bara de adrese a browserului sau cu un curl pe o singură
linie. Serverul interpretează șirul de interogare în același corp pe care îl vede handlerul metodei,
așa că regulile de mai jos contează mai mult aici decât la POST.
Tipul declarat al unui câmp decide cum este citită valoarea lui din șirul de interogare:
- string: folosită ca atare.
- number: trecută prin
Number(...). - boolean: doar șirul literal
trueeste citit catrue. Orice altceva transmiți pentru un câmp boolean laGET, inclusivfalse, este convertit la un1evaluat ca adevărat. Dacă un boolean contează, trimite-l laPOSTcu untrue/falseJSON real sau omite pur și simplu parametrul de interogare, ca să rămână la valoarea implicită a metodei. - object / array: valoarea este trecută prin
JSON.parse(...), așa că o valoare imbricată laGETtrebuie să fie un parametru de interogare care conține un șir JSON (filters=%7B%22status%22%3A%22open%22%7D), nu o imbricare în stil paranteze în interogare.
Câmpuri obligatorii și erori de tip
Fiecare câmp al unei metode are un indicator mandatory și un type. Dacă lipsește un câmp
obligatoriu sau trimiți tipul greșit la POST (unde nu se convertește nimic automat), primești
înapoi un -1 înainte ca metoda însăși să ruleze:
Referința API interactivă listează câmpurile fiecărei metode cu tipurile și indicatorii lor obligatorii și te lasă să rulezi un apel din browser, ca să vezi cererea exactă pe care a construit-o.