Работа с методами API Битрикс24 в приложении REST Активити


Где можно найти доступные методы API Битрикс24 и как найти нужный?

Все методы API Битрикс24 представлены в документации по ссылке: https://apidocs.bitrix24.ru/api-reference/index.html

Найти нужный метод можно двумя способами: поиск по содержимому документации или с помощью поиска по сайту, где можно начать вводить описание искомого метода.



Как использовать методы API Битрикс24?

Чтобы понять как можно использовать метод - можно всегда обратиться в документацию API Битрикс24, где будет дано описание метода и дополнительная информация по его использованию.

Для методов в документации всегда можно найти следующие пункты, которые помогут вам применить его именно так, как вам нужно:

  1. Параметры метода - параметры, которые принимает метод (в большинстве случаев обязательные параметры будут отмечены символом звездочки *);
  2. Важные уточнения при использовании метода - для некоторых методов очень важно учитывать порядок параметров или способ их передачи (если это не описано в описании поле, то может быть описано в уточнениях);
  3. Примеры кода - в этом блоке представлены примеры использования методов на разных языках, на основе которых вы можете создать свой запрос.

Помимо указанной выше информации в методах описываются в каком виде передавать параметры FILTR и ORDER - важно обращать на это внимание, поскольку у разных методов эти параметры могут приниматься в разном виде (например, капсом или, наоборот, строчными буквами).


Комментарии