1.1.3 тип возвращаемого методами api контента: различия между версиями
Shihov (обсуждение | вклад) Нет описания правки |
Shihov (обсуждение | вклад) Нет описания правки |
||
| Строка 1: | Строка 1: | ||
====== Тип возвращаемого методами API контента ====== | |||
Методы API преимущественно возвращают ответы в формате JSON, т.е. MIME-type application/json. Некоторые методы в корректном ответе возвращают двоичное содержимое (например, документы в zip) MIME-type application/zip или application/octet-stream, а в случае ошибки - описание этой самой ошибки в JSON. Таким образом, один и тот же метод в | Методы API преимущественно возвращают ответы в формате JSON, т.е. MIME-type application/json. Некоторые методы в корректном ответе возвращают двоичное содержимое (например, документы в zip) MIME-type application/zip или application/octet-stream, а в случае ошибки - описание этой самой ошибки в JSON. Таким образом, один и тот же метод в | ||
Версия от 07:58, 28 марта 2025
Тип возвращаемого методами API контента
Методы API преимущественно возвращают ответы в формате JSON, т.е. MIME-type application/json. Некоторые методы в корректном ответе возвращают двоичное содержимое (например, документы в zip) MIME-type application/zip или application/octet-stream, а в случае ошибки - описание этой самой ошибки в JSON. Таким образом, один и тот же метод в зависимости от ситуации может вернуть разные типы содержимого (контента).
Для корректной работы методов API параметр Accept заголовка запроса должен быть установлен так, чтобы учитывались все возможные ответы сервера, т.е. и application/zip, и application/json. Самый простой вариант - использовать универсальный шаблон: <1c>Accept: */*</1c> Для ограничения набора возвращаемых типов контента можно указывать несколько заголовков запроса методов: <1c>Accept: application/octet-stream Accept: application/json</1c>
Если в перечне заголовков запроса методов API не окажется ни одного подходящего под сгенерированный сервером ответ, то API вернется ответ c кодом = 406 (Not Acceptable) с пустым телом ответа.
