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

REST API Битрикс24 — это мощный инструмент для интеграции внешних систем с CRM, задачами, календарем, контактами и другими модулями платформы. С помощью REST API можно автоматизировать процессы, получать и обновлять данные, создавать отчёты и расширять функциональность Битрикс24. В этой статье мы подробно рассмотрим работу с API, примеры кода и ответы на часто задаваемые вопросы.

1. Что такое REST API Битрикс24

REST API Битрикс24 позволяет получать доступ к ресурсам CRM, задач, календарей, пользователей и других модулей через HTTP-запросы. В основе API лежит архитектура REST, что делает его удобным для интеграции с любыми языками программирования: PHP, Python, JavaScript и др.

2. Как получить доступ к REST API

Для работы с API необходимы:

• Домен вашей организации в Битрикс24 (например, https://example.bitrix24.ru)
• Авторизация через вебхук или OAuth 2.0
• Знание структуры методов API

2.1. Вебхуки

Простой способ — создать вебхук для приложения. Для этого:

1. Войдите в Битрикс24 → Настройки → Приложения → Вебхуки.
2. Создайте входящий вебхук и выберите права доступа (CRM, задачи, пользователи).
3. Скопируйте URL вебхука для использования в коде.

2.2. OAuth 2.0

Для публичных приложений и интеграций с внешними сервисами используется OAuth 2.0:

• Регистрация приложения на https://dev.1c-bitrix.ru
• Получение client_id и client_secret
• Процесс авторизации через redirect URI и получение access_token

3. Примеры работы с REST API

3.1. Получение списка контактов (PHP)

3.2. Добавление сделки (PHP)

 [
    'TITLE' => 'Новая сделка',
    'CONTACT_ID' => 123,
    'OPPORTUNITY' => 5000,
    'CURRENCY_ID' => 'RUB',
  ]
];
$options = [
  'http' => [
    'header'  => "Content-type: application/json\r\n",
    'method'  => 'POST',
    'content' => json_encode($postData),
  ]
];
$context  = stream_context_create($options);
$result = file_get_contents($webhook, false, $context);
print_r(json_decode($result, true));
?>

3.3. Обновление данных пользователя

POST https://example.bitrix24.ru/rest/1/your_webhook_code/user.update.json
{
  "id": 45,
  "fields": {
    "NAME": "Иван",
    "LAST_NAME": "Иванов"
  }
}

4. Популярные методы REST API Битрикс24

• crm.contact.list — получение списка контактов
• crm.contact.add — добавление контакта
• crm.deal.list — получение списка сделок
• crm.deal.add — создание сделки
• user.get — получение информации о пользователях
• task.item.list — получение задач
• calendar.event.add — создание события календаря

5. Частые ошибки при работе с API

• Ошибка 401 — неверный вебхук или истёк access_token
• Ошибка 403 — недостаточно прав для выполнения метода
• Ошибка 404 — неверный URL метода
• Ошибка 500 — внутренняя ошибка сервера, попробуйте повторить запрос

6. FAQ — Часто задаваемые вопросы

1. Что такое REST API в Битрикс24?
Это интерфейс для доступа к данным CRM, задачам, календарям и пользователям через HTTP-запросы.

2. Как быстро получить доступ к API?
Самый простой способ — создать входящий вебхук в Битрикс24 и использовать его URL.

3. Какие языки программирования можно использовать?
Любой, поддерживающий HTTP-запросы: PHP, Python, JavaScript, Java, C#.

4. Можно ли работать с API без доступа администратора?
Нет, права доступа вебхука или OAuth определяют, какие модули и методы доступны.

5. Где найти документацию?
Полная документация REST API Битрикс24 доступна на https://dev.1c-bitrix.ru/rest_help/