Ilmoitukset-API

Ylläpitäjä: Aether365-tiimi Kohderyhmä: Kehittäjät Laajuus: Ilmoitusasetusten API-päätepisteet

Hallitse sähköposti- ja Teams-ilmoitusasetuksia todennetulle vuokralaiselle.

Hae ilmoitusasetukset

GET /tenants/me/notifications

Esimerkkipyyntö

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

Esimerkkivastaus

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

Vastauksen kentät

Kenttä	Tyyppi	Kuvaus
emailOnComplete	boolean	Lähetä sähköposti skannauksen valmistuessa onnistuneesti
emailOnFail	boolean	Lähetä sähköposti skannauksen epäonnistuessa
teamsWebhookUrl	string tai null	Microsoft Teams -saapuvan webhookin URL
teamsOnComplete	boolean	Lähetä viesti Teamsiin skannauksen valmistuessa
teamsOnFail	boolean	Lähetä viesti Teamsiin skannauksen epäonnistuessa

---

Päivitä ilmoitusasetukset

Päivittää ilmoitusasetukset. Vain mukaan otetut kentät muutetaan.

PATCH /tenants/me/notifications

Pyynnön runko

Kaikki kentät ovat valinnaisia. Sisällytä vain kentät, joita haluat muuttaa.

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

Esimerkki: Ota Teams-ilmoitukset käyttöön

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
  }'

Esimerkki: Poista kaikki sähköposti-ilmoitukset käytöstä

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

Esimerkkivastaus

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

Virheet

Koodi	HTTP	Kuvaus
AUTH_INSUFFICIENT_SCOPE	403	Riittämättömät oikeudet tälle toiminnolle
VALIDATION_ERROR	400	Virheellinen webhook-URL-muoto