Dokumentatsioon

Alusta Postline'iga turvaliselt

Domeeni kinnitamine, API juurdepääs, sandbox-saatmine, suppression ja tarnesündmused.

Uuendatud 24. juulil 2026Ava API teatmik

Tootmisvalmiduse kontrollnimekiri

Kinnita From-domeeni omandiõigus.
Avalda väljastatud DKIM-kirje ja luba return-path infrastruktuur SPF kaudu.
Seadista DMARC vastavus (alignment) ja vaata tulemus üle enne tootmiskeskkonnas saatmise lubamist.
Kasuta sandboxis piiratud õigustega testivõtit ja tootmises eraldi live-võtit.
Töötle bounce- ja complaint-webhooke idempotentselt ning järgi suppression-otsuseid.

POST /v1/emails

Päring / Vastus

curl --request POST 'https://api.srs-postline.com/v1/emails' \
  --header 'Authorization: Bearer srs_live_...' \
  --header 'Idempotency-Key: order_4821' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "from": "Postline <info@example.com>",
    "to": ["user@example.net"],
    "subject": "Your order is ready",
    "html": "<p>Order #4821 is ready.</p>",
    "text": "Order #4821 is ready."
  }'

HTTP/1.1 202 Accepted
Content-Type: application/json

{
  "id": "msg_01JPOSTLINEEXAMPLE",
  "status": "queued",
  "created_at": "2026-08-22T12:00:00Z"
}

Sisendparameetrid

Parameeter	Tüüp	Kohustuslik	Kirjeldus	Näide
`Authorization`	`header · string`	Jah	Töölaual väljastatud piiratud API võti Bearer-tokenina.	`Bearer srs_live_…`
`Idempotency-Key`	`header · string`	Ei	Ühe loogilise saatmise püsiv identifikaator; tungivalt soovitatav.	`order_4821`
`from`	`string`	Jah	Saatja nimi ja aadress kinnitatud domeenil.	`Postline <info@example.com>`
`to`	`string[]`	Jah	Üks kuni 100 saaja e-posti aadressi.	`["user@example.net"]`
`subject`	`string`	Jah	Sõnumi teema.	`Teie tellimus on valmis`
`html`	`string`	Ei	HTML-sisu. Vähemalt üks väljadest html või text on kohustuslik.	`<p>…</p>`
`text`	`string`	Ei	Lihtteksti sisu. Vähemalt üks väljadest text või html on kohustuslik.	`Tellimus #4821…`

Vastusekoodid

Olek	HTTP	Kirjeldus
`202`	Accepted	Sõnum on järjekorras; see ei tähenda veel postkasti jõudmist.
`400`	Bad Request	Vigane JSON või toetamata väljad.
`401`	Unauthorized	API võti on vigane, aegunud või tühistatud.
`403`	Forbidden	Scope puudub või saatja domeen ei ole kinnitatud.
`422`	Unprocessable Entity	Saaja on suppression-loendis.
`429`	Too Many Requests	Projekti päringulimiit on ületatud.

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
  "error": "recipient suppressed"
}

Autentimise terminoloogia

Postline signeerib sõnumeid DKIM-iga. SPF on DNS-is avaldatud autoriseerimispoliitika. DMARC hindab nähtava From-domeeni ja autenditud SPF- või DKIM-identiteedi vastavust; SPF ja DMARC ei ole sõnumi signatuurid.

TLS kaitseb andmeid edastamise ajal toetatud vahelülide vahel. Tavaline e-kiri ei ole otsast lõpuni krüpteeritud ja saaja teenusepakkuja saab sõnumi sisu töödelda.

Kättetoimetamise tulemused

See, et saaja server sõnumi vastu võtab, ei tõenda selle jõudmist postkasti. Käsitle accepted, deferred, hard bounce, soft bounce, complaint, suppressed, rämpsposti paigutust ja postkasti paigutust erinevate tulemustena.

Praegune juurdepääsumudel

Praegused võtmed kasutavad prefiksit srs_live_. Enne From-domeeni kinnitamist saab ühine sandbox-saatja saata ainult projekti liikmetele. Seejärel kehtivad paketipiirangud, suppression, saajapiirangud ja väärkasutuse kontroll. 202 tähendab järjekorda, mitte kohaletoimetamist.

Integratsiooniressursid

Kasuta inimeste ja AI-agentide samm-sammulist juhendit; väljade tõeallikas on OpenAPI.