Overzicht van REST API-endpoints
Met de REST API van SMTPeter kun je e-mails versturen en gegevens over berichten, events, sender domains en templates opvragen of beheren.
Hieronder vind je alle beschikbare endpoints, de bijbehorende HTTP-methoden en hun functies.
Alle endpointpaden beginnen met https://www.smtpeter.com. Vervang waarden
tussen accolades, zoals {messageid} en {domein}, door de bijbehorende
bericht-ID of domeinnaam.
Bijvoorbeeld:
/v1/events/messageid/{messageid}
Met bericht-ID 12345 wordt dit:
/v1/events/messageid/12345
Voor het gebruik van de API heb je een access token nodig. In REST API configureren lees je hoe je verbinding maakt en je access token gebruikt.
GET: gegevens opvragen
| Methode | Endpoint | Omschrijving |
|---|---|---|
| GET | /v1/attachments/{messageid} |
Een overzicht van de bijlagen van een verzonden bericht opvragen. |
| GET | /v1/attachments/{messageid}/{bestand} |
Een bijlage downloaden op basis van naam of volgnummer. |
| GET | /v1/datarequest/{id}/status |
De status van een dataverzoek opvragen. |
| GET | /v1/datarequest/{id} |
De resultaten van een dataverzoek opvragen. |
| GET | /v1/dkimkey/{domein} |
De publieke DKIM-sleutel en bijbehorende gegevens van een sender domain opvragen. |
| GET | /v1/dkimkeys |
De DKIM-sleutels van een sender domain opvragen. |
| GET | /v1/dmarc |
Datums opvragen waarvoor mogelijk DMARC-rapporten beschikbaar zijn. |
| GET | /v1/dmarc/{datum}/{from}/{for} |
Een DMARC-rapport voor een specifieke datum en domeincombinatie opvragen. |
| GET | /v1/dns/{domein}/recommended |
De aanbevolen DNS-records voor een sender domain opvragen. |
| GET | /v1/dns/{domein}/selfhosted |
DNS-records voor een zelfbeheerde configuratie opvragen. |
| GET | /v1/dns/{domein}/status |
De DNS-configuratie en validatiestatus van een sender domain controleren. |
| GET | /v1/domain/{domein} |
De instellingen van een sender domain opvragen. |
| GET | /v1/domains |
Alle geconfigureerde sender domains opvragen. |
| GET | /v1/embeds/{messageid} |
Een overzicht van de ingesloten bestanden van een verzonden bericht opvragen. |
| GET | /v1/embeds/{messageid}/{bestand} |
Een ingesloten bestand downloaden op basis van naam of volgnummer. |
| GET | /v1/envelope/{messageid} |
Het envelope-adres van een verzonden bericht opvragen. |
| GET | /v1/events/messageid/{messageid} |
Events van een specifiek bericht opvragen. |
| GET | /v1/events/email/{emailadres} |
Events voor een specifiek e-mailadres opvragen. |
| GET | /v1/events/template/{templateid} |
Events van een specifieke template opvragen. |
| GET | /v1/tags/{tag} |
Events op basis van een of meerdere tags opvragen. |
| GET | /v1/webhooks |
De ingestelde webhooks opvragen. |
| GET | /v1/headers/{messageid} |
De e-mailheaders van een verzonden bericht opvragen. |
| GET | /v1/html/{messageid} |
De HTML-inhoud van een verzonden bericht opvragen. |
| GET | /v1/text/{messageid} |
De tekstinhoud van een verzonden bericht opvragen. |
| GET | /v1/logfiles |
Datums opvragen waarvoor logbestanden beschikbaar zijn. |
| GET | /v1/logfiles/{datum} |
De beschikbare logbestanden voor een specifieke datum opvragen. |
| GET | /v1/logfiles/{bestand} |
Een specifiek logbestand opvragen. |
| GET | /v1/recipient/{messageid} |
Het oorspronkelijke ontvangstadres van een verzonden bericht opvragen. |
| GET | /v1/spf |
SPF-informatie opvragen. |
| GET | /v1/template/{id} |
Een specifieke template opvragen, eventueel in een gekozen formaat. |
| GET | /v1/templates |
Beschikbare templates en hun ID's opvragen. |
POST: gegevens aanmaken en acties uitvoeren
| Methode | Endpoint | Omschrijving |
|---|---|---|
| POST | /v1/datarequest |
Een dataverzoek aanmaken. |
| POST | /v1/dkimkey |
Een DKIM-sleutel toevoegen aan een sender domain. |
| POST | /v1/domain/{domein} |
Een sender domain aanmaken of de instellingen bijwerken. |
| POST | /v1/webhook |
Een webhook configureren. |
| POST | /v1/resend |
Een eerder verzonden bericht opnieuw versturen. |
| POST | /v1/send |
Een e-mail aanbieden aan SMTPeter voor verzending. |
| POST | /v1/spf |
Een SPF-record binnen SMTPeter aanmaken. |
| POST | /v1/template/{formaat} |
Een template aanmaken. |
PUT: gegevens bijwerken
| Methode | Endpoint | Omschrijving |
|---|---|---|
| PUT | /v1/template/{formaat} |
Een bestaande template bijwerken. |
DELETE: gegevens verwijderen
| Methode | Endpoint | Omschrijving |
|---|---|---|
| DELETE | /v1/dkimkey |
Een DKIM-sleutel verwijderen. |
| DELETE | /v1/domain/{domein} |
Een sender domain verwijderen. |
| DELETE | /v1/domain/{domein}/{emailadres} |
Een toegevoegd DMARC-rapportageadres verwijderen. |
| DELETE | /v1/spf |
Een SPF-record uit SMTPeter verwijderen. |
| DELETE | /v1/template |
Een template verwijderen. |
