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