Skip to content

Latest commit

 

History

History
37 lines (19 loc) · 3.73 KB

first-rest-api-call.md

File metadata and controls

37 lines (19 loc) · 3.73 KB

Как выполнить свой первый запрос к API?

Зайдите в свой Битрикс24 и перейдите в раздел Разработчикам по ссылке в левом меню. Чтобы увидеть этот пункт меню, надо развернуть раздел Приложения.

Входящий вебхук

В открывшемся слайдере нажмите на раздел «Другое», а затем выберите блок «Входящий вебхук».

{% note info "Входящий вебхук" %}

Самый простой способ использования REST – это вызов через так называемый входящий вебхук, представляющий собой постоянный "ключ" API с правами пользователя, который создал этот вебхук.

{% endnote %}

Когда вы откроете слайдер создания входящего вебхука, вы увидите, что Битрикс24 уже сгенерировал уникальный код этого вебхука.

{% note alert "Храните код в секрете!" %}

Этот код, фактически, является ключом доступа или паролем к вебхуку, поэтому вы должны тщательно следить за тем, чтобы он оставался в секрете.

{% endnote %}

Генератор запросов

Под кодом вебхука в слайдере, вы видите блок Генератор запросов.

Он позволяет прямо из интерфейса Битрикс24 выполнять те или иные запросы к REST API Битрикс24, выбирая различные методы из списка и настраивая соответствующие параметры методов. Информацию о конкретных параметрах вы можете узнать из справочника, переходя по ссылкам в документацию.

Когда вы указали параметры и значения параметров, Битрикс24 формирует полный http-запрос за вас. Вы можете его подсмотреть, скопировать во внешнюю систему (или браузер) для выполнения, или можете выполнить прямо здесь и сейчас, нажав кнопку Выполнить.

Когда вы выполните запрос, вы получите ответ от Битрикс24 в формате JSON. Поздравляем с вашим первым успешным выполненным обращением к REST API Битрикс24!

{% note info %}

Входящие вебхуки - это инструмент, очень удобный для использования REST API в решении индивидуальных задач. Однако, если вы хотите реализовать более сложные сценарии на своём Битрикс24, в которые будут вовлечены разные пользователи, или вы хотите разработать тиражное решения для размещения в Битрикс24 Маркет, то для работы с REST вам потребуется использовать авторизацию OAuth 2.0 с временными безопасными токенами авторизации.

{% endnote %}