index.md

Основные положения

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

Последовательность чтения материалов

Ключевые разделы API, которые дадут общее представление о самых важных возможностях:

%%{init: { "theme": "forest" } }%%
flowchart LR
    1[1. Авторизация, 
    OAuth 2.0]
    2[2. Установка и удаление 
    приложений]
    3[3. Встройка 
    виджетов]
    4[4. Обработка 
    событий]
    5[5. Различия облака 
    и коробки]
    1 --> 2
    2 --> 3
    3 --> 4
    4 --> 5

Loading

Чтобы облегчить процесс изучения и использования REST API Битрикс24, предлагается следующая последовательность чтения материалов:

1. {#T}: Этот раздел поможет вам быстро проверить, как работает REST API, и ознакомит с базовыми принципами выполнения запросов.
2. {#T}: Понимание типов данных, которые используются в REST API, критически важно для корректной работы с методами и событиями.
3. {#T}: Здесь описаны механизмы авторизации на основе стандарта OAuth 2.0, получение и продление токенов в приложениях.
4. {#T} и {#T}: В этом разделе рассматриваются процессы установки и удаления приложений в аккаунтах Битрикс24, что особенно важно для разработчиков тиражных приложений.
5. {#T}: Объясняются особенности доступа приложений и вебхуков к различным методам REST API, что позволяет настроить необходимый уровень доступа.
6. {#T}: Здесь описаны способы интеграции пользовательских виджетов в интерфейс Битрикс24 для расширения его функциональности.
7. {#T}: Раздел посвящен механизму событий REST API, позволяющему отслеживать изменения в данных и реагировать на них с помощью специальных серверных обработчиков.
8. {#T}: Обсуждаются способы создания интерактивных приложений, использующих возможности REST API для взаимодействия back-end приложений с их front-end.
9. {#T}: Важные аспекты, связанные с производительностью приложений и ограничениями, налагаемыми на использование REST API.
10. {#T}: Раздел, посвященный JavaScript SDK, который упрощает работу с REST API на клиентской стороне.
11. {#T}: Обзор PHP SDK для работы с REST API, предоставляющий удобные инструменты для серверной разработки.
12. {#T}: Разъясняются ключевые отличия между облачной и коробочной версиями платформы с точки зрения использования REST API.
13. {#T}: Описание общих методов, доступных в REST API, которые могут быть использованы в различных приложениях.

{.large-list}

Инструмент Битрикс24

Битрикс24 - комплексный продукт, объединяющий много различных инструментов, интегрированных между собой. Такая интеграция даёт разработчикам возможность предлагать пользователям законченные бизнес-сценарии с использованием нескольких инструментов.

Справочник API содержит описание доступных методов, событий и виджетов соответствующих инструментов Битрикс24.

1. {#T}
2. {#T}
3. {#T}
4. Лента новостей
5. {#T}
6. Пользователи
7. Бизнес-процессы
8. Задачи
9. Генератор документов
10. {#T}
11. Платежные системы
12. {#T}
13. {#T}
14. Рабочие группы и проекты
15. Открытые линии
16. Чат-боты
17. Чаты
18. Сайты и магазины
19. Провайдеры сообщений, SMS-провайдеры
20. Универсальные списки
21. Учет рабочего времени
22. Хранилище данных
23. Торговый каталог
24. Телефония
25. Диск
26. Почтовые сервисы