Naar de inhoud

API-documentatie

SecuFiler API

Verstuur bestanden tot 5 TB vanuit een backend-systeem naar een of meer ontvangers, zonder handelingen van een gebruiker. Grote bestanden worden in delen geüpload.

Versie
1.0.3

Basis-URL

  • Productiehttps://public-api.secumail.nl
  • Testhttps://test-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/secufiler

Create a transfer and initiate the multipart upload

Request body application/json

VeldTypeOmschrijving
sender *string (email)

Sender email address.

recipients *string (email)[]

One or more recipient email addresses.

filename *string
filesize *integer (int64)

Total size of the file in bytes. Used to compute partSize / partCount. Maximum 5 TiB (5497558138880 bytes).

subjectstring

Subject shown in the notification email.

messagestring

Message body shown in the notification email.

nta7516boolean

Apply NTA 7516 (Dutch secure healthcare email) handling. Honoured only when the sender's domain is a SecuMailer customer certified for NTA 7516; forced to false otherwise.

Voorbeeld

{
  "sender": "system@customer.example",
  "recipients": [
    "bob@partner.example"
  ],
  "filename": "archive.zip",
  "filesize": 10737418240
}

Responses

  • 201

    Transfer created and multipart upload initiated.

  • 400

    Invalid or missing request parameters — e.g. missing sender/recipients/ filename/filesize, malformed email, unknown nonce/uploadId, or SecuFiler not activated for the customer.

  • 401

    Missing or invalid API key.

  • 403

    The sender's domain is not an eligible SecuMailer customer, or SecuFiler is not activated for it.

  • 413

    Requested filesize exceeds the 5 TiB maximum.

  • 500

    Server-side failure.

POST/secufiler/part

Get a presigned URL for one upload part

Upload the part with a single HTTP PUT of that slice of the file to the returned url, then read the ETag response header — you will need the { partNumber, etag } pairs to complete the upload.

Request body application/json

VeldTypeOmschrijving
nonce *string (uuid)

Transfer id from the create response.

uploadId *string
partNumber *integer

Part number (1..partCount).

Voorbeeld

{
  "nonce": "8f14e45f-ceea-467d-9f0a-1c2d3e4f5a6b",
  "uploadId": "2~Zt1p0Yx9c0bWq3n8sample-upload-id",
  "partNumber": 1
}

Responses

  • 200

    Presigned URL for the requested part.

  • 400

    Invalid or missing request parameters — e.g. missing sender/recipients/ filename/filesize, malformed email, unknown nonce/uploadId, or SecuFiler not activated for the customer.

  • 401

    Missing or invalid API key.

  • 500

    Server-side failure.

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