Wywoływanie metody
POST albo GET, treść kontra ciąg zapytania i czego oczekuje walidator pól.
Nazwa metody jest częścią adresu URL. Każde inne wejście, także identyfikator, jest parametrem: polem
treści JSON w POST, parametrem ciągu zapytania w GET. Obie formy dochodzą do tej samej metody i
zwracają tę samą kopertę.
POST: treść JSON
Normalny kształt dla wszystkiego z więcej niż kilkoma parametrami albo z zagnieżdżonym obiektem lub tablicą.
GET: ciąg zapytania
Przydatne do szybkiego sprawdzenia z paska adresu przeglądarki albo jednolinijkowego curl. Serwer
parsuje ciąg zapytania do tej samej treści, którą widzi handler metody, więc poniższe zasady mają tu
większe znaczenie niż w POST.
O tym, jak odczytywana jest wartość z ciągu zapytania, decyduje zadeklarowany typ pola:
- string: używany bez zmian.
- number: przepuszczany przez
Number(...). - boolean: tylko dosłowny ciąg
truejest odczytywany jakotrue. Wszystko inne, co przekażesz dla pola boolean wGET, takżefalse, jest rzutowane na prawdziwe1. Jeśli boolean ma znaczenie, wyślij go wPOSTjako prawdziwe JSON-owetrue/falsealbo po prostu pomiń parametr zapytania, żeby zostało domyślne ustawienie metody. - object / array: wartość jest przepuszczana przez
JSON.parse(...), więc zagnieżdżona wartość wGETmusi być jednym parametrem zapytania z ciągiem JSON (filters=%7B%22status%22%3A%22open%22%7D), a nie zagnieżdżeniem w stylu nawiasów.
Wymagane pola i błędy typów
Pola metody mają flagę mandatory i type. Brak obowiązkowego pola albo wysłanie złego typu w POST
(gdzie nic nie jest automatycznie rzutowane) daje w odpowiedzi -1, zanim sama metoda w ogóle się uruchomi:
Interaktywna dokumentacja API wymienia pola każdej metody z ich typami i flagami obowiązkowości i pozwala uruchomić wywołanie z przeglądarki, żeby zobaczyć dokładnie zbudowane żądanie.