Документация для разработчиков

Использование методов REST

Для использования методов REST необходимо либо создать локальное приложение в рамках конкретного Битрикс24 или вебхук, либо разработать тиражное решение и добавить его в партнерский кабинет. Эти варианты описаны в курсе Приложения для Битрикс24. В общем виде вызов метода REST для локальных и тиражных приложений выглядит как HTTPS-запрос следующего вида

https://домен_Б24.bitrix24.{ru|com|de}/rest/имя_метода.транспорт?параметры_метода&auth=ключ_авторизации

"транспорт" - необязательный параметр, который может иметь значения json или xml. По умолчанию - json.

Запрос может отправляться как методом GET, так и POST.

Значения параметров методов принимаются в кодировке UTF-8.

Для вебхуков синтаксис вызова отличается, однако все равно содержит имя метода, параметры метода и транспорт.

Фактически, это означает, что вы можете обращаться к методам REST API Битрикс24 используя любые языки программирования и средства разработки, которые поддерживают работу с HTTPS.

Помните об ограничениях на интенсивные запросы к REST, описанные в курсе «Приложения для Битрикс24».


Внимание: все ключи входящих массивов должны передаваться в верхнем регистре.



Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2019, «1С-Битрикс», 2019
Наверх