Naar de inhoud

API-documentatie

Reseller API

Voor partners: meld de domeinen van uw klanten automatisch aan, zonder tussenkomst van een medewerker. Authenticatie met OAuth 2.0 (client credentials).

Versie
1.1.1

Basis-URL

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

Authenticatie

  • OAuth 2.0 (client credentials), access token in de header Authorization

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

Endpoints

POST/reseller/account

Onboard a customer domain (third-party resellers)

This is the endpoint for third-party resellers. Authenticate with the OAuth 2.0 client-credentials grant and send the resulting access token - see the security scheme.

{
  "domain":  "<domain>",
  "user":    "<user>",
  "org":     "<org>",
  "prefix":  "secumailer",
  "contact": "secumailer"
}

prefix and contact are hard-coded server-side and are not taken from the request body.

Request body application/json

Voorbeeld

{
  "domain": "example.nl",
  "user": "info@example.nl",
  "org": "Example B.V."
}

Responses

  • 201

    The success status is 201, not 200. The method declares 201, 400 and 500 and no 200 at all. A client that treats only 200 as success will misread every successful call.

  • 400

    The request body was absent, could not be parsed, carried no attributes at all, or a mandatory attribute (domain, user, org) was absent or empty. errorMessage names the offending attribute, or the body itself.

    Produced by the method's .*\[Bad Request\].* integration response. Verified live on acceptance.

  • 401
  • 403

    Authenticated but not permitted: a WAF block, a resource-policy denial, or - on /reseller/account - a token whose scope claim does not include the scope the method requires.

  • 415
  • 429

    * production - api.secumail.nl, stage prd: 100 requests/second sustained, 500 burst * acceptance - test-api.secumail.nl, stage acc: 10 requests/second sustained, 50 burst

    Neither stage configures a quota, so QUOTA_EXCEEDED does not arise. A 429 here is always a rate or burst breach.

  • 500
  • 504

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