SmengoAPI

Обзор API

Smengo API — это программный доступ к данным вашей организации: сотрудники, отделы, график и другие ресурсы платформы. Он нужен для интеграций, BI-выгрузок и автоматизированной синхронизации данных с внешними системами — без ручного экспорта из интерфейса.

Как устроен API

API работает поверх HTTPS и версионируется в пути: базовый адрес — https://smengo.com/api/v1. Обратно несовместимые изменения будут выходить как /api/v2, а не как правки текущей версии — так существующие интеграции не ломаются исподтишка.

Ответы — всегда JSON, включая ошибки. Формат ответов и пагинация описаны в Конвенциях.

Сейчас API строго read-only — только GET-запросы. Эндпоинты для записи (создание смен, отметок и так далее) не входят в v1 и появятся отдельным этапом по запросу.

Что доступно сейчас

В v1 открыты три ресурса:

  • GET /org — данные организации (название, таймзона, локаль).
  • GET /departments — список отделов.
  • GET /employees — список сотрудников.

На подходе: график смен, отметки прихода/ухода, табель и данные о спросе. Полный список ресурсов — в Справочнике эндпоинтов.

API-ключ — серверный секрет

Каждый запрос аутентифицируется API-ключом организации (см. Аутентификацию). Ключ нельзя использовать в коде, который выполняется в браузере пользователя — CORS для /api/v1 выключен намеренно, запросы с чужого домена не пройдут. Держите ключ на сервере — в бэкенде вашей интеграции, скрипте или serverless-функции — и никогда не встраивайте его в клиентский JavaScript.

Что дальше

Была ли статья полезна?