दस्तावेज़ीकरण

Postline के साथ सुरक्षित शुरुआत करें

डोमेन सत्यापन, API एक्सेस, sandbox भेजना, suppression, और डिलीवरी इवेंट्स।

API reference खोलें

बाहरी भेजने की चेकलिस्ट

  • प्रोडक्शन API कुंजी तुरंत उपलब्ध है।
  • डोमेन सत्यापन से पहले sandbox@srs-postline.com से केवल प्रोजेक्ट सदस्य को भेजें।
  • From डोमेन सत्यापित करें, DKIM प्रकाशित करें और SPF से return-path अधिकृत करें।
  • बाहरी प्राप्तकर्ताओं को भेजने से पहले DMARC alignment जाँचें।
  • bounce और complaint webhook को idempotent तरीके से प्रोसेस करें और suppression निर्णयों का पालन करें।
POST /v1/emails

अनुरोध / प्रतिक्रिया

अनुरोधcURL
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."
  }'
प्रतिक्रिया202 Accepted
HTTP/1.1 202 Accepted
Content-Type: application/json

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

इनपुट पैरामीटर

पैरामीटरप्रकारआवश्यकविवरणउदाहरण
Authorizationheader · stringहाँBearer टोकन के रूप में डैशबोर्ड से जारी scoped API कुंजी।Bearer srs_live_…
Idempotency-Keyheader · stringनहींएक तार्किक प्रेषण के लिए स्थिर पहचानकर्ता; इसकी दृढ़ अनुशंसा की जाती है।order_4821
fromstringहाँसत्यापित डोमेन पर प्रेषक का नाम और पता।Postline <info@example.com>
tostring[]हाँएक से 100 प्राप्तकर्ता ईमेल पते।["user@example.net"]
subjectstringहाँसंदेश का विषय।आपका ऑर्डर तैयार है
htmlstringनहींHTML बॉडी। html या text में से एक आवश्यक है।<p>…</p>
textstringनहींसादा-पाठ बॉडी। text या html में से एक आवश्यक है।ऑर्डर #4821…

प्रतिक्रिया कोड

स्थितिHTTPविवरण
202Acceptedसंदेश कतार में है; इसका अर्थ इनबॉक्स में डिलीवरी नहीं है।
400Bad Requestअमान्य JSON या असमर्थित फ़ील्ड।
401UnauthorizedAPI कुंजी अमान्य, समाप्त या निरस्त है।
403Forbiddenscope अनुपलब्ध है या प्रेषक डोमेन सत्यापित नहीं है।
422Unprocessable Entityप्राप्तकर्ता suppression सूची में है।
429Too Many Requestsप्रोजेक्ट की अनुरोध सीमा पार हो गई।
त्रुटि उदाहरण422 Unprocessable Entity
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
  "error": "recipient suppressed"
}

प्रमाणीकरण की शब्दावली

Postline संदेशों को DKIM-साइन करता है। SPF DNS में प्रकाशित एक अधिकृति नीति है। DMARC दृश्यमान From डोमेन और प्रमाणित SPF या DKIM पहचान के बीच alignment का मूल्यांकन करता है; SPF और DMARC संदेश हस्ताक्षर के रूप में लागू नहीं होते।

TLS समर्थित hop के बीच पारगमन में डेटा की सुरक्षा करता है। सामान्य ईमेल end-to-end एन्क्रिप्टेड नहीं होता, और प्राप्तकर्ता प्रदाता संदेश की सामग्री को प्रोसेस कर सकता है।

डिलीवरी परिणाम

किसी प्राप्तकर्ता सर्वर द्वारा संदेश स्वीकार करना इनबॉक्स प्लेसमेंट साबित नहीं करता। accepted, deferred, hard bounce, soft bounce, complaint, suppressed, spam placement, और inbox placement को अलग-अलग परिणाम मानें।

वर्तमान access model

वर्तमान keys srs_live_ उपयोग करती हैं। From domain verify होने से पहले shared sandbox sender केवल project members को भेज सकता है। उसके बाद plan quota, suppression, recipient throttling और abuse controls लागू रहते हैं। 202 का अर्थ queued है, delivered नहीं।

इंटीग्रेशन संसाधन

मनुष्यों और AI agents के लिए step-by-step guide उपयोग करें; fields के लिए OpenAPI source of truth है।