REST API

REST API

Saada ühe JSON-päringuga.

Põhiressursid

POST /v1/emails — lisa sõnum järjekorda GET /v1/emails/{id} — vaata sõnumi olekut

Vastuse mudel

202 tähendab, et sõnum on järjekorda lisatud, mitte postkasti toimetatud. 403 võib viidata puuduvale õiguste ulatusele või kinnitamata domeenile. 422 blokeerib mahasurutud (suppressed) saaja. 429 tähistab kiiruspiirangut (rate limiting).

Teenuse praegused piirangud

REST API ei toeta manuseid. Lubatud kohandatud päised on ainult In-Reply-To, References, List-Unsubscribe ja List-Unsubscribe-Post (kuni 8). Majutatud post on eraldi: veebiklient lubab 20 manust, kokku 25 MiB; avaldatud töölauakliendi saatmispiir on 10 MiB. HTTP 202 ja email.accepted tähendavad töötlemiseks vastuvõtmist; SMTP vastuvõtt ei taga kohaletoimetamist ega postkasti jõudmist.

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.

POST /v1/emails
POST /v1/emails
Authorization: Bearer srs_live_...
Idempotency-Key: reset-4821
Content-Type: application/json

{
  "from": "Sender Name <info@example.com>",
  "to": ["user@example.net"],
  "subject": "Reset your password",
  "html": "<p>Click to reset your password.</p>"
}