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.

Що далі

Чи була стаття корисною?