API WeSetup для разработчиков

Открытый REST API электронных журналов ХАССП: записи в журналы, показания датчиков, сводка за день, вебхуки. Ключ организации, Idempotency-Key, примеры curl.

Авторизация

Ключ организации выдаётся в кабинете: «Настройки → API интеграций». Передавайте его в заголовке Authorization: Bearer <ключ>. Все запросы с ключом пишутся в организацию ключа — organizationId указывать не нужно. Утёк — сбросьте ключ в настройках, старый перестанет работать сразу.

Методы

POST/api/external/entries
Запись в журнал

Создаёт запись в полевом журнале организации. Повтор с тем же Idempotency-Key возвращает прежний ответ без дубля.

curl -X POST https://wesetup.ru/api/external/entries \
  -H "Authorization: Bearer <ключ организации>" \
  -H "Idempotency-Key: 6f1c…" \
  -H "Content-Type: application/json" \
  -d '{
    "journalCode": "hygiene",
    "date": "2026-09-10",
    "data": { "status": "healthy", "temperatureAbove37": false }
  }'
POST/api/external/sensors
Показание датчика

Один вызов — один замер температуры или влажности по оборудованию; отклонения от нормы сразу уходят в уведомления.

curl -X POST https://wesetup.ru/api/external/sensors \
  -H "Authorization: Bearer <ключ организации>" \
  -H "Content-Type: application/json" \
  -d '{ "equipmentId": "clx…", "type": "temperature", "value": 3.8, "timestamp": "2026-09-10T08:00:00+03:00" }'
GET/api/external/summary?date=2026-09-10
Сводка за день

Какие журналы заполнены, какие нет, отклонения и задачи — для панелей и интеграций с учётом.

curl https://wesetup.ru/api/external/summary?date=2026-09-10 \
  -H "Authorization: Bearer <ключ организации>"
GET/api/external/healthz
Проверка доступности

Без ключа. Отвечает 200, если API живо; для мониторинга интеграции.

curl https://wesetup.ru/api/external/healthz
Идемпотентность и ошибки
  • • Idempotency-Key — любой уникальный ключ до 128 символов; повтор в течение 48 часов возвращает тот же ответ.
  • • 401 — нет или неверный ключ; 400 — тело не прошло проверку, в ответе поле error; 429 — превышен лимит, подождите минуту.
  • • Даты — ISO 8601, время организации задаётся её часовым поясом.
Вебхуки

WeSetup может сам присылать события на ваш адрес: запись в журнале, отклонение, задача CAPA, оплата, статус идеи. Подписки настраиваются в «Настройки → Вебхуки»; каждый вызов подписан X-WeSetup-Signature (HMAC-SHA256 тела вашим секретом), неудачные доставки повторяются.

Статус и изменения API

Работает ли сервис — на странице статуса. Изменения API попадают в «Что нового» и RSS. Вопросы — support@wesetup.ru.

Получить ключ