Een API-sleutel aanmaken

Met een API-sleutel verstuurt een toepassing rechtstreeks via de REST API van 2Mail, zonder SMTP-verbinding, en krijgt ze per bericht een identificatie terug om de status op te volgen. U maakt per toepassing een eigen sleutel aan, zodat u ze afzonderlijk kunt intrekken.

Stap 1: de sleutel aanmaken

1. Open in het dashboard van 2Mail het onderdeel met de API-sleutels.
2. Maak een nieuwe sleutel aan en geef ze de naam van de toepassing die ze zal gebruiken: de naam van uw webshop, uw CRM, uw factuurpakket. Geen algemene naam als "productie" — over een jaar weet niemand nog waar die voor diende.
3. Koppel de sleutel aan het verzenddomein of de verzenddomeinen waarvoor ze mag versturen.
4. Bewaar en kopieer de sleutel meteen. Om veiligheidsredenen wordt ze maar één keer volledig getoond; daarna ziet u enkel nog de naam en de laatste tekens.

Stap 2: de sleutel veilig bewaren

Zet de sleutel in de geheime configuratie van uw toepassing — een omgevingsvariabele of een secrets-beheer — en nooit in de broncode, een e-mail of een chatbericht. Wie de sleutel heeft, kan namens uw domein versturen. Gebruik voor uw test- en productieomgeving een aparte sleutel, dan raakt een test nooit uw echte klanten.

Stap 3: de sleutel gebruiken

Uw toepassing stuurt de sleutel mee in de autorisatiekop van elk verzoek aan de API. De documentatie bij de e-mail-API beschrijft de eindpunten voor het versturen van een bericht, het opvragen van de status en het beheren van lijsten. Elk verzoek dat een bericht verstuurt, geeft een identificatie terug; bewaar die bij het bericht in uw eigen systeem, dan kunt u later de status en de bounces eraan koppelen.

Stap 4: testen

Verstuur één bericht naar een extern testadres en controleer het in de afleveringslog van het dashboard. Bij de logregel staat de naam van de sleutel waarmee het verstuurd is — handig om te zien welke toepassing wat verstuurt.

Een sleutel intrekken of vervangen

Vermoedt u dat een sleutel gelekt is, of vertrekt de ontwikkelaar die ze kende, maak dan eerst een nieuwe sleutel aan, zet die in de toepassing, en trek pas daarna de oude in. Zo valt de toepassing nooit stil. Een ingetrokken sleutel werkt onmiddellijk niet meer; verzoeken ermee verschijnen als geweigerd in de log.

Waar het misgaat

• Verzoek geweigerd — de sleutel is verkeerd gekopieerd, ingetrokken, of niet aan het domein gekoppeld waarvoor u verstuurt.
• Sleutel kwijt — ze kan niet opnieuw getoond worden; maak een nieuwe aan.
• Eén sleutel voor alles — werkt, tot u er één toepassing mee moet uitschakelen. Splits ze op.

Wilt u ook afleveringen, bounces en openingen terug in uw toepassing, stel dan een webhook in.

Lukt het niet?

Geef ons via contact de naam van de sleutel en het tijdstip van uw verzoek. Nooit de sleutel zelf — die hoeven wij niet te zien.