Edasi

Saada kirju oma süsteemist

Üks HTTP-päring tekstiga ja aadressiga ning trükitud, frankeeritud kiri kukub kellegi postkasti. Ei mingit printerit, marke ega postkontorisse minekut.

Loo võti

Kogu liidestus

Ongi kõik. Vastus kannab id-d, millega olekut loed, ja seesama id ilmub sinu arvereale.

curl
curl -X POST https://sendletter.eu/api/v1/letters \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Geachte heer, mevrouw,\n\nHierbij zeg ik mijn abonnement op.",
    "subject": "Opzegging",
    "sender":    { "name": "Jan de Vries", "street": "Merelstraat", "number": "64",
                   "postalCode": "8916 AX", "city": "Leeuwarden", "country": "NL" },
    "recipient": { "company": "Voorbeeld BV", "name": "Afdeling Klantenservice",
                   "street": "Hoofdstraat", "number": "1",
                   "postalCode": "1011 AA", "city": "Amsterdam", "country": "NL" },
    "product": "standard",
    "idempotencyKey": "opzegging-2026-07-28"
  }'
Node.js
const res = await fetch("https://sendletter.eu/api/v1/letters", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SENDLETTER_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ text, sender, recipient, product: "registered",
                         // Optional. Bills a company you belong to instead of
                         // this key's own wallet; leave it out for a personal
                         // letter. One you may not spend is refused, not billed
                         // to you.
                         organizationId: company.id,
                         idempotencyKey: invoice.id }),
})
const letter = await res.json()
// letter.id is what you store; poll it or wait for the webhook.
// letter.billedToOrganizationId says which wallet actually paid.
PHP
$ch = curl_init("https://sendletter.eu/api/v1/letters");
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer " . getenv("SENDLETTER_KEY"),
    "Content-Type: application/json",
  ],
  CURLOPT_POSTFIELDS => json_encode([
    "text" => $body, "sender" => $sender, "recipient" => $recipient,
    "idempotencyKey" => $invoiceId,
  ]),
]);
$letter = json_decode(curl_exec($ch), true);
Python
import os, requests

letter = requests.post(
    "https://sendletter.eu/api/v1/letters",
    headers={"Authorization": f"Bearer {os.environ['SENDLETTER_KEY']}"},
    json={"text": body, "sender": sender, "recipient": recipient,
          "idempotencyKey": invoice_id},
    timeout=30,
).json()

Võtmed

Iga päring kannab API-võtit bearer-tokenina. Võtmeid teed oma kontol ja näed iga võtit täpselt üks kord; meie hoiame ainult räsi. Võtme tühistamine hakkab kohe kehtima.

Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxx

Proovi enne, kui postitad

Võti, mis algab sk_test_, arvutab hinna ja koostab kirja täpselt nagu päris võti, aga jääb printeri ees seisma. Nii saad kogu liidestuse läbi harjutada, ilma et midagi teele läheks.

Lõpp-punktid

POST/api/v1/lettersSend a letter
GET/api/v1/lettersList letters, newest first
GET/api/v1/letters/{id}One letter, with its timeline
POST/api/quotePrice, and what that country can be sent(no key)
GET/api/countriesDestinations and their address rules(no key)
GET/api/v1/openapi.jsonThe machine readable spec(no key)

Iga sihtriik ei müü iga toodet. Küsi /api/quote ja loe availableProducts: Hollandisse näiteks tähitud kirja teenust ei ole. Nii saad valiku välja lülitada, mitte lasta sel saatmise hetkel puruneda.

41 destinations. Registered mail: DE, BE, FR, ES, CH.

Statuses

queued
Accepted and waiting on the print partner.
processing
An exclusive hand-off to the print partner is in progress.
attention_required
The provider result is uncertain; held for reconciliation and never retried automatically.
submitted
Handed over to the printer.
printed
Printed and enveloped.
posted
Handed to the carrier. A response deadline runs from here.
delivered
Confirmed delivered. Registered mail only.
failed
Not sent. `statusDetail` says why, and the payment is returned.

Olekuteated sinu süsteemidesse

Kiri vahetab mõne päeva jooksul olekut käputäie kordi. Küsitlemine sellesse rütmi ei sobi: kas küsid palju liiga tihti või kuuled palju liiga hilja. Registreeri oma kontol aadress ja me anname ise teada.

POST your-endpoint
X-SendLetter-Event: letter.posted
X-SendLetter-Signature: 9f86d081...

{ "type": "letter.posted",
  "sentAt": "2026-07-28T18:30:00.000Z",
  "letter": { "id": "AbC123", "status": "posted", "trackingCode": null, ... } }

Iga teade on allkirjastatud. Arvuta toorest kehast oma saladusega HMAC-SHA256 ja võrdle seda päisega X-SendLetter-Signature. Tee seda enne keha parsimist: parsimine ja uuesti serialiseerimine muudavad baite ning siis ei klapi allkiri enam kunagi.

Node.js
import crypto from "node:crypto"

// The raw body, before any JSON parsing.
const expected = crypto.createHmac("sha256", process.env.WEBHOOK_SECRET)
  .update(rawBody, "utf8").digest("hex")
const sent = req.headers["x-sendletter-signature"]

if (expected.length !== sent.length ||
    !crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(sent))) {
  return res.status(401).end()
}

Vead

Igal veal on sama kuju: kood, mille järgi hargned, ja sõnum, mida loed. Hargne koodi järgi, sest sõnum võib muutuda.

{ "error": { "code": "no_route",
             "message": "Registered mail has no route to NL",
             "details": null },
  "requestId": "req_018f38d7c9f34738adbe1f06a9b36f11" }

Every response also carries X-Request-Id. Include that value when asking support about one call; use the letter id to reconcile the complete order.

401unauthorisedNo key, a revoked key, or a malformed header.
400invalid_requestThe body failed validation. `details` names the fields.
402insufficient_balanceThe wallet is short. `details` carries required and available.
403insufficient_scope / credential_spending_limitThe key lacks a scope or its per-letter ceiling is too low. Nothing is charged.
429rate_limited / credential_spending_limitA request, daily-spend or monthly-spend ceiling was reached.
403organization_forbiddenThe named organisation exists and this account is in it, but its role may not spend there. Nothing is charged, to it or to you.
404organization_not_foundNo organisation of that id that this account belongs to. Refused rather than billed to your own wallet.
409no_routeThat product is not sold to that country. Ask /api/quote first.
413too_many_pagesOver the sheet limit for that destination.
404not_foundNo such letter on this account.

OpenAPI

Täisspetsifikatsiooni serveerime otse, nii et see ei saa kunagi kirjeldada versiooni, mis ei tööta. Suuna generaator selle peale ja klient on sinu enda keeles olemas.