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

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

Для использования методов REST внешними приложениями, приложение должно быть зарегистрировано в маркетплейсе (см. описание параметра "Использует только API"). В этом случае у приложения есть все необходимые данные для получения ключа OAuth 2.0.

В общем виде вызов метода REST выглядит вот так:

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

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

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

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

Внимание! Существует лимит на число запросов. Разрешается два запроса в секунду. Если лимит превышается, то ограничение начинает срабатывать после 100 запросов.

Примеры:

https://my.bitrix24.ru/rest/methods.xml?auth=d161f25928c3184678924ec127edd29a - получить список доступных методов в формате xml.

https://my.bitrix24.ru/rest/entity.item.get.json?ENTITY=menu&auth=d161f25928c3184678924ec127edd29a - получить в формате json список всех элементов сущности menu.

Некоторые методы могут принимать в качестве значений параметров файлы. В этом случае в качестве значения параметра можно отправить массив, первым элементом которого будет имя файла, а вторым - его содержимое, закодированное в base64. Либо просто строку с содержимым файла в base64 (в этом случае имя файла будет сгенерировано автоматически).

Общий формат ответа (любое из полей может присутствовать или отсутствовать, но всегда есть result или error):

{
	"result":результат выполнения метода,
	"error":ошибка выполнения метода,
	"total":общее количество записей в ответе списочного метода,
	"next":значение, которое нужно послать для получение следующей страницы данных списочного метода
}

Списочные методы возвращают данные страницами по 50 элементов (число может изменяться). Для получения следующей страницы данных к запросу нужно добавить параметр start со значением, пришедшем в параметре next ответа.

Исключение из этого - метод пакетного выполнения запросов batch, который возвращает ответ вида:

{
	"result":массив результатов запросов пакета,
	"result_error":массив ошибок запросов пакета,
	"result_total":массив количеств записей в ответах списочных методов,
	"result_next":массив значений, возвращенных в полях next запросов
}



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

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

Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.

Добавлять комментарии могут только зарегистрированные пользователи. Сообщения для просмотра появляются после модерации.
© «Битрикс», 2001-2017, «1C-Битрикс», 2017