Aloita ilmaiseksi
Valikko
Tässä osiossa

API: avaimet, päätepisteet ja webhookit

Mihin pyyntöihin API vastaa?

Pro-paketista alkaen

API vastaa alla oleviin pyyntöihin. OpenAPI-dokumentti osoitteessa https://www.mailmoni.com/api/v1/openapi.json kuvaa jokaisen niistä kokonaan: parametrit, vastauksen kentät ja virheet, joita pyyntö voi palauttaa. Tämä taulukko kootaan samasta dokumentista, joten ne kertovat aina samaa.

PyyntöMitä se tekee
GET /api/v1/alertsLuettele hälytykset uusimmasta alkaen samoilla tiedoilla kuin hälytysten webhookit
GET /api/v1/domainsLuettele organisaation käytössä olevat verkkotunnukset, kunkin pääverkkotunnuksen perässä sen aliverkkotunnukset
GET /api/v1/domains/{domain}Hae yksi verkkotunnus aliverkkotunnuksineen, raportointiosoitteineen ja DNS-tarkistusten määrineen
GET /api/v1/domains/{domain}/dnsHae jokaisen DNS-tietueen viimeisin tarkistus, jokainen havainto selitettynä
GET /api/v1/domains/{domain}/dns/historyLuettele, mitä verkkotunnuksen DNS-tietueet sisälsivät ajan mittaan, uusimmasta alkaen
GET /api/v1/domains/{domain}/recordsLuettele aikavälin koontitietueet uusimmasta alkaen, kukin tietue selitettynä
GET /api/v1/domains/{domain}/reportsLuettele yhden tyypin raportit aikavälillä uusimmasta alkaen
GET /api/v1/domains/{domain}/sourcesLuettele aikavälin lähteet suurimmasta alkaen sovelluksen arvion ja selityksen kanssa
GET /api/v1/domains/{domain}/sources/{source_id}Hae yksi lähde selityksineen, toimenpiteineen, osoitteineen ja viimeisimpine tietueineen
GET /api/v1/domains/{domain}/summaryViestit, DMARC-tulokset, käytäntö ja valmius aikavälillä
POST /api/v1/exportsAloita yhden verkkotunnuksen tietueiden tai raporttitiedostojen vienti
GET /api/v1/exports/{export_id}Lue viennin tila
GET /api/v1/exports/{export_id}/downloadLataa valmis vienti: CSV, NDJSON tai raporttitiedostojen zip
GET /api/v1/organizationLue organisaatio, johon avain kuuluu
GET /api/v1/reports/{kind}/{report_id}Hae yksi jäsennetty raportti
GET /api/v1/reports/{kind}/{report_id}/rawLataa raporttitiedosto sellaisena kuin se vastaanotettiin: koontiraportista XML, TLS-raportista JSON, kokonaisena säilytetystä forensic-raportista viesti

API:n yleiskuvaus kertoo sen, mikä on yhteistä kaikille pyynnöille: avaimen, tuntilaskurin, sivutuksen, päivät ja virheet.

Verkkotunnus polussa

Polkuun tulee jokin organisaatiosi verkkotunnuksista, joko pääverkkotunnus tai aliverkkotunnus, esimerkiksi example.com tai mail.example.com. Aliverkkotunnuksen pyyntö lukee sen pääverkkotunnuksen lähteet ja tietueet rajattuina aliverkkotunnuksesta lähetettyyn postiin, samalla tavalla kuin sovellus ne näyttää. Toisen organisaation verkkotunnus saa vastauksen not_found, aivan kuten verkkotunnus, jota ei ole.

Raportit

Raportin laji on aggregate, tls tai forensic. Verkkotunnuksen raporttiluetteloon voi valita yhden lajin kind-parametrilla. Ilman parametria se listaa koontiraportit.

Yhden koontiraportin vastauksessa on enintään 500 sen tietuetta. Jos raportissa on enemmän, records_truncated on true ja record_count kertoo, montako niitä on. Tietuepyyntö listaa aikavälin kaikki tietueet, ja jokainen tietue nimeää raporttinsa kentässä report, joten loput saat pyytämällä tietueet raportin päiviltä.

raw-pyyntö antaa tiedoston, josta luimme raportin, valmiiksi purettuna gzip- tai zip-paketista: koontiraportin XML:n, TLS-raportin JSONin ja forensic-raportin alkuperäisen viestin, jos säilytämme sen kokonaisena.

Aloita vienti

Teams-paketista alkaen avain, jolla on kirjoitusoikeus, aloittaa viennin pyynnöllä POST /api/v1/exports. Runko on JSON-objekti, jossa on nämä kentät:

Kenttä Mitä se kertoo
domain Pakollinen. Verkkotunnus tai aliverkkotunnus. Aliverkkotunnuksen vienti sisältää sen pääverkkotunnuksen tiedot aliverkkotunnuksesta lähetetystä postista.
kind Pakollinen. records_csv, records_ndjson tai raw, jos haluat raporttitiedostot zip-tiedostona.
from, to Päivät samoin kuin kaikissa pyynnöissä. Ilman niitä viimeiset 7 päivää, joista viimeinen on eilinen.
report_kinds Vain raw-viennissä. Mitkä tahansa lajeista aggregate, tls ja forensic. Ilman kenttää ["aggregate"].
header_from Vain posti, jonka From-verkkotunnus on tämä. Aliverkkotunnuksen viennissä se voi olla vain aliverkkotunnus itse.

Muut kentät hylätään vastauksella invalid_parameter, joka nimeää kentän.

curl -X POST https://www.mailmoni.com/api/v1/exports \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain": "example.com", "kind": "records_csv", "from": "2026-10-01", "to": "2026-10-26"}'

Vastauksen tila on 202, ja siinä ovat viennin tiedot ja Location-otsake. Hae tuota osoitetta uudelleen, kunnes viennin status on ready, tai anna export.ready-webhookin kertoa se. Lataa sitten tiedosto osoitteesta download_url.

  • Kun vientiä vielä kootaan, latauspyyntö saa vastauksen export_running.
  • Epäonnistuneella viennillä ei ole tiedostoa, ja sen latauspyyntö saa vastauksen not_found. Aloita uusi vienti.
  • Säilytämme tiedostoa 7 päivää. Sen jälkeen latauspyyntö saa vastauksen export_expired.
  • Organisaatiolle kootaan yksi vienti kerrallaan, sovelluksessa aloitetut mukaan lukien. Toinen pyyntö, kun edellinen odottaa tai on kesken, saa vastauksen export_running.
  • API:n kautta aloitetusta viennistä ei lähetetä sähköpostia. Sovelluksessa aloitetusta viennistä lähetetään.

Julkaistu 27. lokakuuta 2026 · Tarkistettu 27. lokakuuta 2026