प्राधिकरण और पहुंच क्षेत्र
लिंक से साइन इन
आपका सर्वर X-API-Key और X-Customer-ID के साथ POST /v1/auth/login-link को कॉल करता है। केवल एक मेलबॉक्स खोलने के लिए mailbox_id दें; पूरा खाता खोलने के लिए इसे छोड़ दें। locale इंटरफ़ेस की भाषा चुनता है।
जवाब में login_url, expires_in=300, expires_at (UTC), account_id और mailbox_id मिलते हैं। “मेल खोलें” बटन #token सहित पूरा login_url खोलता है। लिंक 5 मिनट तक और केवल एक बार मान्य है। इसे लॉग में न लिखें और API कुंजी ब्राउज़र में उजागर न करें।
साइन इन पृष्ठ पता बार से टोकन हटा देता है और उसके बदले HttpOnly कुकीज़ प्राप्त करता है। त्रुटि या समय सीमा समाप्त होने पर नया लिंक बनाएँ। पहुँच का दायरा तथा खाते और मेलबॉक्स की स्थिति दोबारा जाँची जाती है। उपयोगकर्ता सत्र लिंक नहीं बना सकते।
curl https://adapt-mail.com/v1/auth/login-link \ -H "X-API-Key: <mail-api-key>" \ -H "X-Customer-ID: <mail-account-id>" \ -H "Content-Type: application/json" \ --data '{"mailbox_id":42,"locale":"en"}'
{ "login_url": "https://adapt-mail.com/auth/#token=<one-time-token>", "expires_in": 300, "expires_at": "2026-10-20T12:05:00Z", "account_id": 123, "mailbox_id": 42}साझेदार कुंजी
अपने एकीकरण की मेल API-कुंजी का उपयोग करें। इसे X-API-Key और मेल खाते के ID को भेजें - आवश्यक हेडर X-Customer-ID. में यह खाते का ID है, न कि external_id और मेलबॉक्स का ID नहीं। कुंजी केवल आपके एकीकरण के ग्राहकों तक पहुंच की अनुमति देती है।
कुंजी को अपने भागीदार के सर्वर पर संग्रहीत करें. साझा एकीकरण कुंजी को ब्राउज़र या मोबाइल एप्लिकेशन में न रखें।
curl 'https://adapt-mail.com/v1/mailboxes' \ -H 'X-API-Key: <mail-api-key>' \ -H 'X-Customer-ID: <mail-account-id>'उपयोगकर्ता टोकन
POST /v1/auth/token login, password और mode. स्वीकार करता है mode=account के लिए लॉगिन user-ID का उपयोग किया जाता है, mode=mailbox के लिए पूर्ण मेलबॉक्स पता का उपयोग किया जाता है। खाता और मेलबॉक्स पासवर्ड स्वतंत्र हैं.
प्रतिक्रिया में access_token, token_type=Bearer और expires_in=3600. शामिल हैं खाता टोकन अपने बॉक्स खोलता है; बॉक्स टोकन - केवल एक बॉक्स। समाप्ति के बाद, आपको एक नया टोकन प्राप्त होगा।
POST /v1/auth/tokenContent-Type: application/json
{"login":"user-123","password":"<password>","mode":"account"}
GET /v1/mailboxesAuthorization: Bearer <access_token>ब्राउज़र सत्र
POST /v1/auth/login अपनी साइट के लिए है adapt-mail.com. इसके लिए सही Origin की आवश्यकता होती है और HttpOnly cookies. इंस्टॉल होता है। अवर्गीकृत X-Mail-Session सहेजे गए इनपुट में से एक का चयन करता है, लेकिन cookie के बिना एक्सेस नहीं देता है।
तृतीय-पक्ष फ़्रंटएंड के लिए, अपने सर्वर और उपयोगकर्ता टोकन का उपयोग करें। किसी भी साइट नंबर के लिए cookie: सार्वजनिक CORS से यादृच्छिक क्रॉस-डोमेन एक्सेस पर भरोसा न करें।