Технические ошибки документации Wialon

Здравствуйте. В процессе разработки столкнулся с очень грубой технической ошибкой документации. Согласно документации запрос к API должен формироваться методом POST параметры запроса params должны быть отправлены в формате JSON. Так же в документации указано, что необходимо указать заголовок: Content-Type:application/x-www-form-urlencoded. Но есть одно большое но! Передача заголовка не гарантирует что параметры будут отправляться из тела запроса. А согласно документации шаблон запроса показан как строка с query-параметрами. Это в корне неверное представление. В таком случае программист который будет совершать интеграцию будет передавать параметры не в теле запроса, а в URL как urlencoded параметры. Основные проблемы, что мы получаем при таком решении это пользователь может при выполнении запроса получить 414 Uri Too Long и кроме того, вместо гарантированого json который так указан в документации мы успешно получаем html от nginx или openresty. Как это выглядит для конечного пользователя API? В пользователя падает парсер JSON и он наивно пытается найти проблему почему валится парсер, находит  ошибку 414 но он не может сократить количество и размер параметров, также при попытке подсмотреть в браузере  все сложно, так как при отправке запроса в консоле девелопера query-параметры и параметры x-www-form-encoded выглядят практически одинаково. Кроме того API допускает выполнение запроса как и используя query так и используя x-www-form-encoded и никаким образом не информирует пользователя об том что какой то из подходов неверен.

Как этого избежать? Надо уделить время документированию, потому что эта проблема критична на фундаментальном уровне. Кроме того надо указать что параметры x-www-form-encoded надо передавать в теле запроса, а не в  URL. Или показать возможные варианты подключения к примеру на этой странице: https://sdk.wialon.com/wiki/ru/local/re … /reqformat

Иначе все же интеграторам придется писать свои собственные инструкции об этом, а это уже документация на документацию