दस्तावेज़ पर जाएँ
API

त्वरित शुरुआत

एक कुंजी और पहला भेजा हुआ मेल।

1. कुंजी बनाएँ

  1. Settings → API keys खोलें। यह पेज तभी दिखता है जब मेलबॉक्स आपका है।
  2. उसका नाम उसी चीज़ पर रखें जो उसे इस्तेमाल करेगी। कुछ रद्द करना पड़े तो उसी नाम से आप उसे दोबारा ढूँढ़ेंगे।
  3. उसके स्कोप चुनें। डिफ़ॉल्ट रूप से केवल भेजना।
  4. चाहें तो सीमित करें कि वह किसके रूप में भेज सकती है: पूरे डोमेन, अकेले पते, या दोनों। पूरा डोमेन बाद में उसमें जोड़े गए पतों को भी कवर करता है।
  5. कुंजी कॉपी कर लें। वह एक ही बार दिखाई जाती है और वापस नहीं पाई जा सकती: संग्रहित केवल एकतरफ़ा hash होता है। बाद में कुंजी घुमाने पर उसका प्रतिस्थापन भी उसी तरह एक बार दिखता है।

2. कुछ भेजें

npm install @openemail/sdk

वैकल्पिक। हर एंडपॉइंट सादा HTTP और JSON है, और नीचे के curl टैब को कुछ भी इंस्टॉल किए बिना चलाया जा सकता है।

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>"  }'

200 का मतलब है वह चला गया। आपको एक id वापस मिलती है। उसे सँभालकर रखें: उसी से आप संदेश प्राप्त करते हैं, उसका इवेंट-रिकॉर्ड पढ़ते हैं, या शेड्यूल किया हो तो उसे रद्द करते हैं।

अप्रत्याशित 403 मिल रहा है? GET /addresses ठीक-ठीक बताता है कि यह कुंजी किसके रूप में भेज सकती है। कारण लगभग हमेशा कुंजी पर मौजूद send स्कोप, या कोई ऐसा डोमेन या पता होता है जो उसे नहीं दिया गया था — वर्कस्पेस पर गायब डोमेन नहीं।