Naar de inhoud

API-documentatie

SecuMailer Public API

Verstuur beveiligde e-mails en meld organisaties en domeinen aan. Pas nadat de DNS-instellingen zijn doorgevoerd, kunt u via het platform e-mail versturen.

Versie
1.3.8

Basis-URL

  • Testhttps://test-public-api.secumail.nl/
  • Productiehttps://public-api.secumail.nl/

Authenticatie

  • API-sleutel in de header x-api-key

Een API-sleutel of toegangsgegevens vraagt u aan via contact.

Endpoints

POST/message

Sends a secure email. Each email must have a sender, recipient(s) and a MIME encoded, escaped email message. Each email must have an unique Message-ID in the message body.

If you are sending NTA 7516 compliant emails, you must include the X-SecuMailer-NTA7516:true header in the header part of the body attribute.

If you require 2FA authentication of the recipient(s) you can add the mobile phone number of any recipient to the email address used in “To/Cc/Bcc” header in the header part of the body attribute. This can be done with the following syntax: \<+country code\>\<phone number\>+\<email address\>.

Example: +31612345678+test@email.com

Request body application/json

Voorbeeld

{ "sender": "sender@example.com", "recipient": ["recipient@example.net"], "body": "From: \"Test Sender\" <sender@example.com>\r\nTo: \"Test Recipient\" <recipient@example.net>\r\nMessage-ID: <HE1PR03MB15630A98B97B714C5E9CADCF9F920@HE1PR03MB1563.eurprd03.prod.outlook.com>\r\nDate: Fri, 7 Jun 2019 17:20:19 +0000\r\nSubject: Example\r\nContent-Type: multipart\/mixed;\r\n        boundary=\"_004_6a168860dad6479d9ef568358d518ee5_\"\r\nMIME-Version: 1.0\r\n\r\n--_004_6a168860dad6479d9ef568358d518ee5_\r\nContent-Type: multipart\/alternative;\r\n        boundary=\"_000_6a168860dad6479d9ef568358d518ee5_\"\r\n\r\n--_000_6a168860dad6479d9ef568358d518ee5_\r\nContent-Type: text\/plain; charset=\"iso-8859-1\"\r\nContent-Transfer-Encoding: quoted-printable\r\n\r\n\r\n\r\n--_000_6a168860dad6479d9ef568358d518ee5_\r\nContent-Type: text\/html; charset=\"iso-8859-1\"\r\nContent-Transfer-Encoding: quoted-printable\r\n\r\n<html>\r\n<head>\r\n<meta http-equiv=3D\"Content-Type\" content=3D\"text\/html; charset=3Diso-8859-=\r\n1\">\r\n<style type=3D\"text\/css\" style=3D\"display:none;\"><!-- P {margin-top:0;margi=\r\nn-bottom:0;} --><\/style>\r\n<\/head>\r\n<body dir=3D\"ltr\">\r\n<div id=3D\"divtagdefaultwrapper\" style=3D\"font-size:12pt;color:#000000;font=\r\n-family:Calibri,Helvetica,sans-serif;\" dir=3D\"ltr\">\r\n<p><br>\r\n<\/p>\r\n<\/div>\r\n<\/body>\r\n<\/html>\r\n\r\n--_000_6a168860dad6479d9ef568358d518ee5_--\r\n\r\n--_004_6a168860dad6479d9ef568358d518ee5_\r\nContent-Type: application\/vnd.ms-excel; name=\"data.csv\"\r\nContent-Description: data.csv\r\nContent-Disposition: attachment; filename=\"data.csv\"; size=532;\r\n        creation-date=\"Sun, 01 Jul 2018 17:20:49 GMT\";\r\n        modification-date=\"Sun, 01 Jul 2018 17:20:49 GMT\"\r\nContent-Transfer-Encoding: base64\r\n\r\ndGltZSxEZWxpdmVyZWQsU3VwcHJlc3NlZCxEcm9wcGVkLFBvc3RzIHZpYSBSb3V0ZXMKU2F0IE1h\r\neSAxOSAyMDE4IDAyOjAwOjAwIEdNVCswMjAwIChXZXN0LUV1cm9wYSAoem9tZXJ0aWpkKSksMTAs\r\nMCwxOCwwClN1biBNYXkgMjAgMjAxOCAwMjowMDowMCBHTVQrMDIwMCAoV2VzdC1FdXJvcGEgKHpv\r\nbWVydGlqZCkpLDUsMCw0LDAKTW9uIE1heSAyMSAyMDE4IDAyOjAwOjAwIEdNVCswMjAwIChXZXN0\r\nLUV1cm9wYSAoem9tZXJ0aWpkKSksOCwwLDQsMApUdWUgTWF5IDIyIDIwMTggMDI6MDA6MDAgR01U\r\nKzAyMDAgKFdlc3QtRXVyb3BhICh6b21lcnRpamQpKSwzMSwwLDQsMApXZWQgTWF5IDIzIDIwMTgg\r\nMDI6MDA6MDAgR01UKzAyMDAgKFdlc3QtRXVyb3BhICh6b21lcnRpamQpKSwzMCwwLDAsMApUaHUg\r\nTWF5IDI0IDIwMTggMDI6MDA6MDAgR01UKzAyMDAgKFdlc3QtRXVyb3BhICh6b21lcnRpamQpKSw0\r\nMSwwLDEsMApGcmkgTWF5IDI1IDIwMTggMDI6MDA6MDAgR01UKzAyMDAgKFdlc3QtRXVyb3BhICh6\r\nb21lcnRpamQpKSwzNywwLDAsMA==\r\n\r\n--_004_6a168860dad6479d9ef568358d518ee5_--\r\n" }

Responses

  • 201

    Created

  • 400

    Bad Request

  • 500
GET/account

Retrieves DNS configuration for an organization

Parameters

NaamInTypeOmschrijving
domain *query
reseller *query
statusquery

Responses

  • 200

    OK

  • 400

    Bad Request

  • 404

    Not Found

  • 500
POST/account

Creates a new account for an organization

Request body application/json

Voorbeeld

{
  "domain": "customer.com",
  "reseller": "info@secumailer.com",
  "org": "SecuMailer",
  "prefix": "secumailer",
  "user": "webshop@secumailer.com",
  "contact": "someone@customer.com"
}

Responses

  • 201

    Created

  • 400

    Bad Request

  • 500
POST/address

Creates a new address for an organization

Request body application/json

Voorbeeld

{
  "mailbox": "info@secumailer.com",
  "address": "user@example.com",
  "phonenumber": "+31612312300",
  "shared_password": "abcde12345"
}

Responses

  • 200

    OK

  • 400

    Bad Request

  • 403

    Forbidden

Velden met * zijn verplicht. De technische omschrijvingen komen uit de OpenAPI-specificatie en zijn in het Engels.

Koppeling bespreken?

Benieuwd hoe SecuMailer aansluit op uw applicatie?

Plan een gratis demo. We bespreken uw situatie en de beste manier om te koppelen.

Plan een gratis demo