API Сервер

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

Для работы службы, требуются переменные среды:

Параметр	Описание
B24_DOMAIN	Домен системы Битрикс24
B24_TOKEN	Токен пользователя Битрикс24
B24_USERID	Идентификатор пользователя Битрикс24
V1_TOKEN	Ключ верификации запросов протокола V1
VK_CONFKEY	Ключ верификации сервера для VK
VK_TOKEN	Ключ верификации запросов VK

Дополнительные параметры, полезные в разработке:

Параметр	Де-факто	Описание
DEBUG	API:*	Отображение отладочных сообщений
EMAIL	example@domain.org	Логин тестового пользователя
NODE_ENV	development	Режим работы NodeJS
PASSWORD	qwerty123456	Пароль тестового пользователя

Используемые команды

Команда	Описание
npm run lint	Анализ кода
npm run start	Запуск службы
npm run test	Тестирование пакета

Описание протоколов

В службе используются два обработчика запросов:

• V1 - стандартный RESTful протокол
• VK - обработчик событий VK

Подробное описание протоколов:

• Протокол V1;
• Протокол VK;

Подробное описание методов:

• Методы V1;
• Методы VK;

Описание принципа работы

Протоколы разработаны таким образом, что при ошибках, невалидных запросах, некорректных параметрах, сервер отвечает строкой false. Ошибки и предупреждения клиенту не выводятся, чтобы избежать проблем с безопасностью. Входящие запросы, ответы и ошибки записываются в журнал и доступны для просмотра на сервере. Смотрите раздел отладка для подробностей.

При вызове метода, происходит поиск Meteor метода с названием протокол:метод. Например, если вызываете тестовый метод по адресу /v1/test, будет вызываться Meteor метод v1:test. Подробности на страницах описания протоколов.

Вызываемому методу передаются полученные POST и GET переменные в объекте. Входящие параметры верифицируются службой до вызова метода, не прошедшие верификацию запросы отклоняются. При создании методов, требуется выполнять проверку на переданные параметры.

Отладка

Действия и события службы фиксируются. Для вывода сообщений, используйте переменную среды DEBUG.

Примеры использования:

Значение	Описание
*	Отображение всех отладочных сообщений всех модулей
API:*	Отображение всех сообщений службы, используется де-факто
API:v1:*	Отображение отладочных сообщений обработка V1
API:vk:*	Отображение отладочных сообщений обработка VK
API:error	Отображение сообщений об ошибках работы

Дополнительные параметры отображения расписаны на страницах протоколов и методов.

Можно использовать иные способы управления отображением сообщений. Подробности в документации отладочного пакета.

Используемые плагины

• styleschool:bitrix24-adapter Адаптер к системе Битрикс24

Лицензия

MIT. Copyright (c) Valentin Popov.