API за известия

Управление на настройките за имейл и Teams известия за удостоверения tenant.

Получаване на настройки за известия

GET /tenants/me/notifications

Примерна заявка

curl https://api.aether365.io/tenants/me/notifications \
  -H "Authorization: Bearer <token>"

Примерен отговор

{
  "success": true,
  "data": {
    "emailOnComplete": true,
    "emailOnFail": true,
    "teamsWebhookUrl": "https://outlook.office.com/webhook/...",
    "teamsOnComplete": true,
    "teamsOnFail": true
  }
}

Полета в отговора

Поле	Тип	Описание
emailOnComplete	boolean	Изпращане на имейл при успешно завършване на сканиране
emailOnFail	boolean	Изпращане на имейл при неуспешно сканиране
teamsWebhookUrl	string или null	URL на входящ webhook за Microsoft Teams
teamsOnComplete	boolean	Публикуване в Teams при завършване на сканиране
teamsOnFail	boolean	Публикуване в Teams при неуспешно сканиране

---

Актуализиране на настройки за известия

Актуализира настройките за известия. Променят се само полетата, които включите.

PATCH /tenants/me/notifications

Тяло на заявката

Всички полета са незадължителни. Включете само полетата, които искате да промените.

{
  "emailOnComplete": true,
  "emailOnFail": true,
  "teamsWebhookUrl": "https://outlook.office.com/webhook/...",
  "teamsOnComplete": true,
  "teamsOnFail": false
}

Пример: Активиране на Teams известия

curl -X PATCH https://api.aether365.io/tenants/me/notifications \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "teamsWebhookUrl": "https://outlook.office.com/webhook/your-webhook-url",
    "teamsOnComplete": true,
    "teamsOnFail": true
  }'

Пример: Деактивиране на всички имейл известия

curl -X PATCH https://api.aether365.io/tenants/me/notifications \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "emailOnComplete": false,
    "emailOnFail": false
  }'

Примерен отговор

{
  "success": true,
  "data": {
    "emailOnComplete": false,
    "emailOnFail": false,
    "teamsWebhookUrl": "https://outlook.office.com/webhook/...",
    "teamsOnComplete": true,
    "teamsOnFail": true
  }
}

Грешки

Код	HTTP	Описание
AUTH_INSUFFICIENT_SCOPE	403	Недостатъчни права за това действие
VALIDATION_ERROR	400	Невалиден формат на webhook URL