145  /  166

Возможности Rest API

Просмотров: 54922
Дата последнего изменения: 11.08.2023
Александр Суворов
Сложность урока:
2 уровень - несложные понятия и действия, но не расслабляйтесь.
1
2
3
4
5

Rest API предназначено для создания приложений для облачного сервиса Битрикс24.

Rest API позволяет получить доступ и управлять такими инструментами облачного сервиса Битрикс24 как:

  • CRM,
  • Бизнес-процессы,
  • Диск,
  • Социальная сеть,
  • Телефония,
  • Универсальные списки,
  • Хранилища данных (инфоблоки),
  • Уведомления,
  • Задачи,
  • работа с пользователями и с подразделениями,
  • Живая лента,
  • Календари.

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

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

https://домен_Б24.bitrix24.{ru|en|de}/rest/имя_метода.транспорт?параметры_метода&auth=ключ_авторизации
где транспорт - необязательный параметр, который может иметь значения json или xml. По умолчанию - json.

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

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

Внимание! Существует лимит на число запросов. Разрешается два запроса в секунду. Если лимит превышается, то ограничение начинает срабатывать после 50 запросов.
Для тарифа «Энтерпрайз» число запросов - 5 в секунду. Лимит на число запросов - 250.

Примечание: Если Ваше приложение/вебхук создаёт аномальную нагрузку на портал, может сработать блокировка:
[
'error' => 'OVERLOAD_LIMIT',
'error_description' => 'REST API is blocked due to overload.'
]
Для разблокировки необходимо обратиться в техподдержку.

Rest API бот-платформы являются составной частью общей системы REST. Документация по всем остальным методам расположена в Документации REST API Битрикс24 - программный продукт в виде облачного сервиса, а также коробочной версии, созданный компанией "1С-Битрикс". Разработчики могут создавать собственные приложения или интеграции для Битрикс24, используя открытый REST API, который работает как с облачным, так и с коробочным Битрикс24, начиная с версии 16.6.0.

Подробнее ...
.



4
Курсы разработаны в компании «1С-Битрикс»
Доступна новая документация по REST: понятнее описания, больше примеров, удобнее поиск
Перейти