Documentatie

REST API configureren

Met de REST API van SMTPeter kun je vanuit je eigen applicatie e-mails versturen en andere API-functies gebruiken. In dit artikel lees je hoe je een access token aanmaakt en gebruikt om API-requests naar SMTPeter te versturen.

Access token aanmaken

Een access token is een unieke sleutel waarmee SMTPeter je API-requests authenticeert en aan je account koppelt.

Je maakt een access token aan in het SMTPeter-dashboard:

  1. Log in op je SMTPeter-account.
  2. Ga naar Configuratie > API access-tokens.
  3. Maak een nieuw access token aan.
  4. Kopieer de token en sla deze veilig op.

Bewaar je access token buiten je broncode, bijvoorbeeld in een omgevingsvariabele. Zo voorkom je dat de token onbedoeld wordt gedeeld via een openbare repository. Gebruik de token alleen aan de serverzijde van je applicatie. In client-side code kan een bezoeker de token achterhalen.

Omdat de token toegang geeft tot je SMTPeter-account, moet je deze als een wachtwoord behandelen. Is je token openbaar geworden? Trek deze dan in om misbruik te voorkomen en maak een nieuwe aan. Vervang de token ook in alle applicaties die deze gebruiken, zodat API-requests blijven werken.

Verbinding maken met de REST API

Je verstuurt API-requests via een beveiligde HTTPS-verbinding naar een endpoint van SMTPeter. SMTPeter accepteert geen onbeveiligde HTTP-requests.

De algemene structuur van een API-URL is:

https://www.smtpeter.com/v1/ENDPOINT?access_token=YOUR_API_TOKEN

Hierbij vervang je:

  • ENDPOINT door het endpoint dat je wilt aanroepen, bijvoorbeeld send voor e-mailverzending.
  • YOUR_API_TOKEN door je eigen access token.

SMTPeter gebruikt de access token in de URL om je request te authenticeren. Omdat URL's in logbestanden kunnen terechtkomen, moet je voorkomen dat URL's met een access token worden opgeslagen of gedeeld.

Welke HTTP-methode je gebruikt, hangt af van het endpoint. SMTPeter ondersteunt GET, POST en DELETE. In de documentatie van het REST API-eindpunt lees je meer over deze methoden.

Een overzicht van de endpoints en bijbehorende HTTP-methoden vind je bij Alle REST calls.

Verbinding controleren

Je kunt de verbinding testen door een API-request uit te voeren met je access token.

Controleer de HTTP-statuscode en de response van SMTPeter om vast te stellen of de request is verwerkt. Een foutmelding kan bijvoorbeeld wijzen op een ongeldige token, ontbrekende parameters of een verkeerd endpoint.

Bij een timeout weet je niet altijd of SMTPeter de request heeft verwerkt. Voorkom daarom dat je een verzendrequest automatisch opnieuw uitvoert zonder de eerdere verwerking te controleren. Anders kunnen dubbele e-mails ontstaan.

Meer informatie over het verwerken van responses vind je in de documentatie over API-responses.

Voorbeelden voor programmeertalen

Je kunt de REST API gebruiken vanuit iedere programmeertaal die HTTPS-requests ondersteunt.

Voor PHP en Python zijn voorbeelden beschikbaar:

Deze voorbeelden laten zien hoe je API-requests vanuit je applicatie opbouwt en verstuurt. Het zijn twee mogelijke implementaties van de REST API.

Volgende stap: e-mail versturen

Met je access token kun je e-mails versturen via het /v1/send-endpoint.

Op de pagina Verzenden via REST API lees je hoe je een e-mail verstuurt met een POST-request. Je vindt daar een voorbeeld en uitleg over de beschikbare verzendmogelijkheden.

Voordat je e-mails kunt versturen, moet je Senderdomain zijn ingesteld en gevalideerd en moet je account zijn goedgekeurd voor verzending.

Meer informatie