Интеграции — API-ключи и вебхуки

Интеграции нужны, если отчёты Parcar должны попадать во внешнюю систему: 1С, ERP или BI. Есть два способа:

• API-ключ — внешняя система сама читает опубликованные отчёты;
• Вебхук — Parcar сам отправляет отчёт на адрес внешней системы по расписанию.

Раздел доступен только владельцу. Откройте Настройки → Доступ → Интеграции.

Перед началом

Внешняя система видит только отчёты, которые опубликованы для API. Опубликовать отчёт можно на его странице, на вкладке API.

API-ключи

Создать ключ

1. В блоке Новый ключ введите Название, например «1C ERP».
2. В поле Доступ выберите:
   • Все опубликованные отчёты — ключ видит все отчёты, опубликованные для API;
   • Выбранные отчёты — ключ видит только отмеченные отчёты.
3. В поле Срок действия выберите Бессрочно или срок в днях.
4. Нажмите Создать ключ.

Осторожно

Ключ показывается один раз. Сразу скопируйте его и передайте ответственному. Позже увидеть его нельзя: система хранит только его отпечаток.

Статусы ключа

Статус	Что значит
Действует	Ключ работает
Отозван	Ключ отключён вручную
Истёк	Срок действия закончился
Неактивен	Создатель ключа больше не может читать отчёты: его удалили или у него сменилась роль

Ключ действует от имени того, кто его создал. Если создатель отключён или потерял роль владельца или администратора, ключ перестанет работать.

Для неактивного ключа доступна кнопка Передать себе. Ключ получит новый токен, который покажут один раз. Старый токен перестанет работать, поэтому передайте новый ключ тому, кому он нужен.

Отозвать ключ

Нажмите Отозвать в строке ключа. Ключ перестанет работать. Чтобы снова дать доступ, создайте новый ключ.

Вебхук-подключения

Вебхук — это адрес в интернете, куда Parcar отправляет отчёт по расписанию.

В блоке Вебхук-подключения укажите:

• адрес — только https://;
• секрет подписи — система показывает его один раз. Внешняя система по нему проверяет, что сообщение пришло от Parcar;
• дополнительный заголовок — необязательно.

Заметка

Если над блоком видно предупреждение «Секреты вебхуков нельзя сохранить», на сервере не настроены ключи шифрования. Сохранить вебхук нельзя, пока администратор системы не добавит их. Обратитесь к нему.

Справка по REST

В блоке Справка по REST описано, как получить данные отчёта. Частые ошибки:

• 401 — ключ неверный, отозван или неактивен;
• 403 — отчёт не входит в доступ ключа;
• 404 — отчёт не опубликован.
• 429 — слишком много запросов. Ограничение: 60 запросов в минуту на ключ. Подождите и повторите.

Что дальше

• Пользователи — роли участников, которые создают ключи.
• Роли и права — кто может управлять интеграциями.