REST API
आपका मेलबॉक्स, सीधे HTTP पर।
अपने कोड से मेल भेजें, पढ़ें और सँभालें। हर कुंजी के पास सिर्फ़ वही स्कोप होते हैं जो आप उसे देते हैं।
संक्षेप में
ईमेल API क्या है?
ईमेल API सॉफ़्टवेयर को किसी ऐप के बजाय HTTP पर मेल भेजने और पढ़ने देता है। हर अनुरोध पर लगी कुंजी तय करती है कि कॉल करने वाला किन चीज़ों तक पहुँच सकता है।
104
दस्तावेज़ीकृत ऑपरेशन
25
पूरे डोमेन, एक कुंजी के सेंड स्कोप में
50
एकल पते, उनके अलावा
यह कैसे काम करता है
हर कुंजी को एक काम तक सीमित करें
चुनें कि कुंजी के पास कौन-से स्कोप हों, और चाहें तो वह किन प्रेषकों का इस्तेमाल कर सके। स्कोप न होने या सूची से बाहर के प्रेषक पर 403 मिलता है।
दो बार भेजे बिना दोबारा प्रयास
कुछ भी बाहर जाने से पहले हर सेंड को उसकी msg_ id मिल जाती है। वही Idempotency-Key लेकर दोबारा प्रयास पहला ही नतीजा लौटाता है।
सीक्रेट बदलें, कुंजी वही रखें
बदलने पर सिर्फ़ सीक्रेट बदलता है, इसलिए id, स्कोप और अनुरोधों का इतिहास बना रहता है। रद्द की गई कुंजी को revoked_api_key बताया जाता है।
कुंजी में कौन-से स्कोप हो सकते हैं
कुल तीस। नई कुंजियाँ emails:send से शुरू होती हैं।
अपना पहला ईमेल भेजें
सीधा HTTP और JSON। कुछ इंस्टॉल नहीं करना।
curl -X POST https://api.openemail.uk/emails \ -H "Authorization: Bearer $OPENEMAIL_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "from": "Acme Billing <[email protected]>", "to": ["[email protected]"], "subject": "Your September invoice", "html": "<p>Invoice attached.</p>" }'आपको क्या मिलता है
आज प्रोडक्ट में
हर सेंड की एक id
हर प्राप्तकर्ता के लिए /events, ओपन और क्लिक के लिए /tracking।
403 की वजह साफ़
GET /ping कुंजी के स्कोप और उसकी भूमिका ने जो छोड़ा, दोनों दिखाता है।
MCP से कुंजियाँ
MCP सर्वर भी कुंजियों की सूची देता है, उन्हें बदलता, रद्द करता और चालू करता है।
अच्छे तरीक़े
इसका पूरा फ़ायदा उठाएँ
- 01
हर सर्विस के लिए एक कुंजी
तब लीक हुई कुंजी रद्द करने से सारे नहीं, सिर्फ़ एक इंटीग्रेशन रुकता है।
- 02
Idempotency-Key सेट करें
इसे किसी यूनीक चीज़ से बनाएँ, जैसे इनवॉइस नंबर, ताकि दोबारा प्रयास वही नतीजा दोहराए।
- 03
प्रेषक सीमित करें
सिर्फ़ वे पते लिखें जिनसे सर्विस भेजती है। पूरा डोमेन बाद में जोड़े गए पते भी कवर करता है।
अभी की स्थिति
जानने लायक़
- कोई अपलोड एंडपॉइंट नहीं
- इनलाइन अटैचमेंट base64 में, कुल 5 MB तक। बड़ी फ़ाइलें वर्कस्पेस फ़ाइल id से, डाउनलोड लिंक के रूप में जाती हैं।
- सेंड की कोई बाउंस स्थिति नहीं
- GET /emails बाउंस हुए संदेश को भेजा गया दिखाता है। बाउंस उसके प्राप्तकर्ता पर और email.bounced वेबहुक में दिखता है।
सवाल
अक्सर पूछे जाते हैं
आगे पढ़ें
इनके साथ अच्छा चलता है
शुरू करें
आपका डोमेन,
आपका मेल।
किसी डोमेन को OpenEmail की ओर पॉइंट करें और उसका मेल उसी के इर्द-गिर्द बने मेलबॉक्स में पढ़ें। मुफ़्त प्लान में एक डोमेन शामिल है।
