## प्रमाणीकरण

API कुंजी प्राप्त करने और उपयोग करने का तरीका जानें

## API कुंजी प्राप्त करें

API का उपयोग करने से पहले, आपको एक API कुंजी प्राप्त करनी होगी। आप प्रोफ़ाइल पेज पर अपनी API कुंजी बना सकते हैं।

### API कुंजी का उपयोग

सभी API अनुरोधों के लिए अपनी API कुंजी को अनुरोध हेडर में शामिल करें:

[Code (bash)]
X-API-Key: YOUR_API_KEY
[/Code]

### महत्वपूर्ण नोट्स

- अपनी API कुंजी को सुरक्षित रखें और इसे सार्वजनिक स्थानों पर उजागर न करें
- API कुंजी के पास आपके खाते के समान अनुमतियां हैं, इसे सावधानी से उपयोग करें
- यदि आपकी API कुंजी से समझौता हो जाता है, तो तुरंत अपने प्रोफ़ाइल पेज पर एक नई कुंजी पुनः उत्पन्न करें

---

## ईमेल API

ईमेल बनाएं और प्रबंधित करें

## उपलब्ध डोमेन प्राप्त करें

सिस्टम में सभी उपलब्ध ईमेल डोमेन प्राप्त करें।

### अनुरोध

[Code (bash)]
GET /api/email/domains
[/Code]

### अनुरोध उदाहरण

[Code (bash)]
curl https://chat-tempmail.com/api/email/domains \
  -H "X-API-Key: YOUR_API_KEY"
[/Code]

### उत्तर पैरामीटर

पैरामीटर | प्रकार | विवरण
----------- | ------ | -------------
domains | array | उपलब्ध ईमेल डोमेन की सूची

### उत्तर उदाहरण

[Code (json)]
{
  "domains": [
    "chat-tempmail.com",
    "example.com", 
    "other-domain.com"
  ]
}
[/Code]

## ईमेल बनाएं

एक नया अस्थायी ईमेल पता बनाएं।

### अनुरोध

[Code (bash)]
POST /api/emails/generate
[/Code]

### अनुरोध पैरामीटर

पैरामीटर | प्रकार | आवश्यक | विवरण
----------- | ------ | ---------- | -------------
name | string | हाँ | ईमेल प्रीफिक्स
expiryTime | number | हाँ | समाप्ति समय (मिलीसेकंड)<br/>उपलब्ध मान:<br/>- 3600000 (1 घंटा)<br/>- 86400000 (1 दिन)<br/>- 259200000 (3 दिन)<br/>- 0 (स्थायी)
domain | string | हाँ | ईमेल डोमेन

### अनुरोध उदाहरण

[Code (bash)]
curl -X POST https://chat-tempmail.com/api/emails/generate \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "test",
    "expiryTime": 3600000,
    "domain": "chat-tempmail.com"
  }'
[/Code]

### उत्तर पैरामीटर

पैरामीटर | प्रकार | विवरण
----------- | ------ | -------------
id | string | ईमेल की अद्वितीय पहचान (UUID प्रारूप)
email | string | बनाया गया ईमेल पता (पूर्ण ईमेल पता)

### उत्तर उदाहरण

[Code (json)]
{
  "id": "c2c4f894-c672-4d5b-a918-abca95aff1f7",
  "email": "test@chat-tempmail.com"
}
[/Code]

## ईमेल सूची प्राप्त करें

अपने खाते के तहत सभी ईमेल पते प्राप्त करें।

### अनुरोध

[Code (bash)]
GET /api/emails
[/Code]

### अनुरोध पैरामीटर

पैरामीटर | प्रकार | आवश्यक | विवरण
----------- | ------ | ---------- | -------------
cursor | string | नहीं | पेजिनेशन कर्सर, पिछले उत्तर से nextCursor प्राप्त करें

### अनुरोध उदाहरण

[Code (bash)]
curl https://chat-tempmail.com/api/emails \
  -H "X-API-Key: YOUR_API_KEY"
[/Code]

### उत्तर पैरामीटर

पैरामीटर | प्रकार | विवरण
----------- | ------ | -------------
emails | array | ईमेल सूची (प्रति अनुरोध अधिकतम 20 आइटम)
nextCursor | string | अधिक डेटा प्राप्त करने के लिए अगले पेज का कर्सर
total | number | ईमेल की कुल संख्या

### emails सरणी में ईमेल ऑब्जेक्ट

पैरामीटर | प्रकार | विवरण
----------- | ------ | -------------
id | string | ईमेल की अद्वितीय पहचान (UUID प्रारूप)
address | string | ईमेल पता (पूर्ण ईमेल पता)
userId | string | ईमेल का मालिक उपयोगकर्ता ID (UUID प्रारूप)
createdAt | string | ईमेल निर्माण समय (ISO 8601 प्रारूप)
expiresAt | string | ईमेल समाप्ति समय (ISO 8601 प्रारूप)

### उत्तर उदाहरण

[Code (json)]
{
  "emails": [
    {
      "id": "e4ff5c14-8a72-48c5-bd13-b5347fb944da",
      "address": "6Tg3VT@chat-tempmail.com",
      "userId": "bd08008d-e944-44b2-a0d0-67f2b528ee6d",
      "createdAt": "2025-04-21T08:30:45.084Z",
      "expiresAt": "2025-04-22T08:30:45.084Z"
    }
  ],
  "nextCursor": "fd13a8df-1465-4fbc-a612-ca7311c31ff2",
  "total": 20
}
[/Code]

## ईमेल हटाएं

निर्दिष्ट ईमेल पता हटाएं।

### अनुरोध

[Code (bash)]
DELETE /api/emails/{emailId}
[/Code]

### अनुरोध पैरामीटर

पैरामीटर | प्रकार | आवश्यक | विवरण
----------- | ------ | ---------- | -------------
emailId | string | हाँ | ईमेल ID (पथ पैरामीटर)

### अनुरोध उदाहरण

[Code (bash)]
curl -X DELETE "https://chat-tempmail.com/api/emails/99fadf12-6826-490a-9c6c-b0b528d4a8e0" \
  -H "X-API-Key: YOUR_API_KEY"
[/Code]

### उत्तर पैरामीटर

पैरामीटर | प्रकार | विवरण
----------- | ------ | -------------
success | boolean | क्या हटाना सफल था

### उत्तर उदाहरण

[Code (json)]
{
  "success": true
}
[/Code]

---

## संदेश API

संदेश प्रबंधित करें

## संदेश सूची प्राप्त करें

निर्दिष्ट ईमेल पते में सभी संदेश प्राप्त करें।

### अनुरोध

[Code (bash)]
GET /api/emails/{emailId}
[/Code]

### अनुरोध पैरामीटर

पैरामीटर | प्रकार | आवश्यक | विवरण
----------- | ------ | ---------- | -------------
emailId | string | हाँ | ईमेल ID (पथ पैरामीटर)
cursor | string | नहीं | पेजिनेशन कर्सर (क्वेरी पैरामीटर), पिछले उत्तर से nextCursor प्राप्त करें

### अनुरोध उदाहरण

[Code (bash)]
curl "https://chat-tempmail.com/api/emails/c2c4f894-c672-4d5b-a918-abca95aff1f7" \
  -H "X-API-Key: YOUR_API_KEY"
[/Code]

### उत्तर पैरामीटर

पैरामीटर | प्रकार | विवरण
----------- | ------ | -------------
messages | array | संदेश सूची (प्रति अनुरोध अधिकतम 20 आइटम)
nextCursor | string | अधिक डेटा प्राप्त करने के लिए अगले पेज का कर्सर
total | number | संदेशों की कुल संख्या

### messages सरणी में संदेश ऑब्जेक्ट

पैरामीटर | प्रकार | विवरण
----------- | ------ | -------------
id | string | संदेश की अद्वितीय पहचान (UUID प्रारूप)
from_address | string | भेजने वाला पता
subject | string | संदेश विषय
received_at | number | प्राप्ति समय (मिलीसेकंड में Unix टाइमस्टैम्प)

### उत्तर उदाहरण

[Code (json)]
{
  "messages": [
    {
      "id": "fd13a8df-1465-4fbc-a612-ca7311c31ff2",
      "from_address": "sender1@example.com",
      "subject": "Test Message 1 - xJOK2h",
      "received_at": 1745224245084
    }
  ],
  "nextCursor": "eyJ0aW1lc3RhbXAiOjE3NDUxNTU4NDUwODQsImlkIjoiNjNmNzFlODYtOGE1NC00ZDQ0LTk5ZWYtN2QzNTBhMTQ4M2JiIn0=",
  "total": 50
}
[/Code]

## संदेश विवरण प्राप्त करें

निर्दिष्ट संदेश की विस्तृत सामग्री प्राप्त करें।

### अनुरोध

[Code (bash)]
GET /api/emails/{emailId}/{messageId}
[/Code]

### अनुरोध पैरामीटर

पैरामीटर | प्रकार | आवश्यक | विवरण
----------- | ------ | ---------- | -------------
emailId | string | हाँ | ईमेल ID (पथ पैरामीटर)
messageId | string | हाँ | संदेश ID (पथ पैरामीटर)

### अनुरोध उदाहरण

[Code (bash)]
curl "https://chat-tempmail.com/api/emails/99fadf12-6826-490a-9c6c-b0b528d4a8e0/fd13a8df-1465-4fbc-a612-ca7311c31ff2" \
  -H "X-API-Key: YOUR_API_KEY"
[/Code]

### उत्तर पैरामीटर

पैरामीटर | प्रकार | विवरण
----------- | ------ | -------------
message | object | संदेश विवरण

### message ऑब्जेक्ट फील्ड

पैरामीटर | प्रकार | विवरण
----------- | ------ | -------------
id | string | संदेश की अद्वितीय पहचान (UUID प्रारूप)
from_address | string | भेजने वाला पता
subject | string | संदेश विषय
content | string | संदेश प्लेन टेक्स्ट सामग्री
html | string | संदेश HTML सामग्री (खाली हो सकती है)
received_at | number | प्राप्ति समय (मिलीसेकंड में Unix टाइमस्टैम्प)

### उत्तर उदाहरण

[Code (json)]
{
  "message": {
    "id": "fd13a8df-1465-4fbc-a612-ca7311c31ff2",
    "from_address": "sender1@example.com",
    "subject": "Test Message 1 - xJOK2h",
    "content": "Test Message 1\n\nThis is test message 1 content.\n\nBest regards,\nSender 1",
    "html": "<div>\n<h1>Test Message 1</h1>\n </div>",
    "received_at": 1745224245084
  }
}
[/Code]

## संदेश हटाएं

निर्दिष्ट संदेश हटाएं।

### अनुरोध

[Code (bash)]
DELETE /api/emails/{emailId}/{messageId}
[/Code]

### अनुरोध पैरामीटर

पैरामीटर | प्रकार | आवश्यक | विवरण
----------- | ------ | ---------- | -------------
emailId | string | हाँ | ईमेल ID (पथ पैरामीटर)
messageId | string | हाँ | संदेश ID (पथ पैरामीटर)

### अनुरोध उदाहरण

[Code (bash)]
curl -X DELETE "https://chat-tempmail.com/api/emails/76d91ae5-822a-4fdd-8701-9de038ec86d7/20e77445-b0c3-4e8b-aa29-762ea423ac15" \
  -H "X-API-Key: YOUR_API_KEY"
[/Code]

### उत्तर पैरामीटर

पैरामीटर | प्रकार | विवरण
----------- | ------ | -------------
success | boolean | क्या हटाना सफल था

### उत्तर उदाहरण

[Code (json)]
{
  "success": true
}
[/Code]

---

## वेबहुक पुश

संदेश पुश अधिसूचनाएं प्राप्त करने के लिए वेबहुक कॉन्फ़िगर करें

## वेबहुक कॉन्फ़िगरेशन प्राप्त करें

वर्तमान वेबहुक कॉन्फ़िगरेशन जानकारी प्राप्त करें।

### अनुरोध

[Code (bash)]
GET /api/webhook
[/Code]

### अनुरोध उदाहरण

[Code (bash)]
curl https://chat-tempmail.com/api/webhook \
  -H "X-API-Key: YOUR_API_KEY"
[/Code]

### उत्तर पैरामीटर

पैरामीटर | प्रकार | विवरण
----------- | ------ | -------------
url | string | वेबहुक URL पता (खाली स्ट्रिंग हो सकता है)
enabled | boolean | क्या वेबहुक सक्षम है

### उत्तर उदाहरण

[Code (json)]
{
  "url": "https://your-server.com/webhook",
  "enabled": true
}
[/Code]

## वेबहुक कॉन्फ़िगर करें

वेबहुक कॉन्फ़िगरेशन सेट या अपडेट करें।

### अनुरोध

[Code (bash)]
POST /api/webhook
[/Code]

### अनुरोध पैरामीटर

पैरामीटर | प्रकार | आवश्यक | विवरण
----------- | ------ | ---------- | -------------
url | string | हाँ | वेबहुक URL पता (मान्य HTTP/HTTPS URL होना चाहिए)
enabled | boolean | हाँ | क्या वेबहुक सक्षम करना है

### अनुरोध उदाहरण

[Code (bash)]
curl -X POST https://chat-tempmail.com/api/webhook \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-server.com/webhook",
    "enabled": true
  }'
[/Code]

### उत्तर पैरामीटर

पैरामीटर | प्रकार | विवरण
----------- | ------ | -------------
success | boolean | क्या कॉन्फ़िगरेशन सफल था

### उत्तर उदाहरण

[Code (json)]
{
  "success": true
}
[/Code]

## वेबहुक इवेंट्स

जब एक नया संदेश आता है, तो सिस्टम आपके कॉन्फ़िगर किए गए URL पर POST अनुरोध भेजेगा।

### प्राप्त डेटा प्रारूप

अनुरोध हेडर:
- Content-Type: application/json
- X-Webhook-Event: new_message

### वेबहुक पुश डेटा

पैरामीटर | प्रकार | विवरण
----------- | ------ | -------------
emailId | string | ईमेल ID जिसने संदेश प्राप्त किया (UUID प्रारूप)
messageId | string | नया संदेश ID (UUID प्रारूप)
fromAddress | string | भेजने वाला पता
subject | string | संदेश विषय
content | string | संदेश प्लेन टेक्स्ट सामग्री
html | string | संदेश HTML सामग्री (खाली हो सकती है)
receivedAt | string | संदेश प्राप्ति समय (ISO 8601 प्रारूप)
toAddress | string | ईमेल पता जिसने संदेश प्राप्त किया

### पुश डेटा उदाहरण

[Code (json)]
{
  "emailId": "c2c4f894-c672-4d5b-a918-abca95aff1f7",
  "messageId": "fd13a8df-1465-4fbc-a612-ca7311c31ff2",
  "fromAddress": "sender@example.com",
  "subject": "Test Message",
  "content": "Message plain text content",
  "html": "<div>Message HTML content</div>",
  "receivedAt": "2025-01-21T08:30:45.084Z",
  "toAddress": "test@chat-tempmail.com"
}
[/Code]

### उत्तर आवश्यकताएं

आपके सर्वर को सफल प्राप्ति को इंगित करने के लिए 2xx स्थिति कोड वापस करना चाहिए। यदि गैर-2xx स्थिति कोड वापस किया जाता है, तो सिस्टम भेजने का पुनः प्रयास कर सकता है।

अनुशंसित उत्तर:

[Code (json)]
HTTP/1.1 200 OK
Content-Type: application/json

{
  "received": true
}
[/Code]

### महत्वपूर्ण नोट्स

- सुनिश्चित करें कि आपका वेबहुक URL पहुंच योग्य है
- अपने सर्वर साइड पर पुश डेटा की अखंडता को सत्यापित करने की अनुशंसा की जाती है
- जब संदेश आते हैं तो सिस्टम तुरंत वेबहुक पुश भेजेगा
- यदि पुश असफल होते हैं, तो सिस्टम पुनः प्रयास कर सकता है, इसलिए सुनिश्चित करें कि आपका इंटरफेस इडेम्पोटेंट है

---