Использование методов 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 Существует лимит на число запросов. Разрешается два запроса в секунду. Если лимит превышается, то ограничение начинает срабатывать после 50 запросов.

Подробнее в курсе Приложения для Битрикс24.Маркет .

Если Ваше приложение/вебхук создаёт аномальную нагрузку на портал, может сработать блокировка:

[
	'error' => 'OVERLOAD_LIMIT',
	'error_description' => 'REST API is blocked due to overload.'
]

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

Внимание:

- все ключи входящих массивов должны передаваться в верхнем регистре.
- запросы нужно отправлять без BOM.