API za obvestila

Upravljanje nastavitev obvestil po e-pošti in v Teams za overjenega najemnika.

Pridobitev nastavitev obvestil

GET /tenants/me/notifications

Primer zahteve

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

Primer odgovora

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

Polja odgovora

Polje	Vrsta	Opis
emailOnComplete	boolean	Pošlje e-pošto ob uspešnem zaključku skeniranja
emailOnFail	boolean	Pošlje e-pošto ob neuspehu skeniranja
teamsWebhookUrl	string ali null	URL vhodnega spletnega kljuka Microsoft Teams
teamsOnComplete	boolean	Objavi v Teams ob zaključku skeniranja
teamsOnFail	boolean	Objavi v Teams ob neuspehu skeniranja

---

Posodobitev nastavitev obvestil

Posodobi nastavitve obvestil. Spremenjena so samo polja, ki jih vključite.

PATCH /tenants/me/notifications

Telo zahteve

Vsa polja so neobvezna. Vključite samo polja, ki jih želite spremeniti.

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

Primer: Omogočanje obvestil v 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
  }'

Primer: Onemogočanje vseh obvestil po e-pošti

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

Primer odgovora

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

Napake

Koda	HTTP	Opis
AUTH_INSUFFICIENT_SCOPE	403	Nezadostna dovoljenja za to dejanje
VALIDATION_ERROR	400	Neveljavna oblika URL spletnega kljuka