## Authentifizierung Erfahren Sie, wie Sie API-Schlüssel erhalten und verwenden ## API-Schlüssel erhalten Bevor Sie die API verwenden, müssen Sie einen API-Schlüssel erhalten. Sie können Ihren API-Schlüssel auf der Profilseite erstellen. ### API-Schlüssel verwenden Fügen Sie Ihren API-Schlüssel in die Anfrage-Header für alle API-Anfragen ein: [Code (bash)] X-API-Key: YOUR_API_KEY [/Code] ### Wichtige Hinweise - Bewahren Sie Ihren API-Schlüssel sicher auf und stellen Sie ihn nicht an öffentlichen Orten zur Verfügung - Der API-Schlüssel hat dieselben Berechtigungen wie Ihr Konto, verwenden Sie ihn vorsichtig - Falls Ihr API-Schlüssel kompromittiert wurde, generieren Sie sofort einen neuen auf Ihrer Profilseite --- ## E-Mail API E-Mails erstellen und verwalten ## Verfügbare Domains abrufen Alle verfügbaren E-Mail-Domains im System abrufen. ### Anfrage [Code (bash)] GET /api/email/domains [/Code] ### Anfragebeispiel [Code (bash)] curl https://chat-tempmail.com/api/email/domains \ -H "X-API-Key: YOUR_API_KEY" [/Code] ### Antwortparameter Parameter | Typ | Beschreibung ----------- | ----- | -------------- domains | array | Liste der verfügbaren E-Mail-Domains ### Antwortbeispiel [Code (json)] { "domains": [ "chat-tempmail.com", "example.com", "other-domain.com" ] } [/Code] ## E-Mail erstellen Eine neue temporäre E-Mail-Adresse erstellen. ### Anfrage [Code (bash)] POST /api/emails/generate [/Code] ### Anfrageparameter Parameter | Typ | Erforderlich | Beschreibung ----------- | ----- | -------------- | -------------- name | string | Ja | E-Mail-Präfix expiryTime | number | Ja | Ablaufzeit (Millisekunden)
Verfügbare Werte:
- 3600000 (1 Stunde)
- 86400000 (1 Tag)
- 259200000 (3 Tage)
- 0 (permanent) domain | string | Ja | E-Mail-Domain ### Anfragebeispiel [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] ### Antwortparameter Parameter | Typ | Beschreibung ----------- | ----- | -------------- id | string | Eindeutige Kennung der E-Mail (UUID-Format) email | string | Erstellte E-Mail-Adresse (vollständige E-Mail-Adresse) ### Antwortbeispiel [Code (json)] { "id": "c2c4f894-c672-4d5b-a918-abca95aff1f7", "email": "test@chat-tempmail.com" } [/Code] ## E-Mail-Liste abrufen Alle E-Mail-Adressen unter Ihrem Konto abrufen. ### Anfrage [Code (bash)] GET /api/emails [/Code] ### Anfrageparameter Parameter | Typ | Erforderlich | Beschreibung ----------- | ----- | -------------- | -------------- cursor | string | Nein | Paginierungs-Cursor, nextCursor aus vorheriger Antwort abrufen ### Anfragebeispiel [Code (bash)] curl https://chat-tempmail.com/api/emails \ -H "X-API-Key: YOUR_API_KEY" [/Code] ### Antwortparameter Parameter | Typ | Beschreibung ----------- | ----- | -------------- emails | array | E-Mail-Liste (max. 20 Elemente pro Anfrage) nextCursor | string | Nächste Seiten-Cursor für weitere Daten total | number | Gesamtanzahl der E-Mails ### E-Mail-Objekte im emails-Array Parameter | Typ | Beschreibung ----------- | ----- | -------------- id | string | Eindeutige Kennung der E-Mail (UUID-Format) address | string | E-Mail-Adresse (vollständige E-Mail-Adresse) userId | string | Benutzer-ID des E-Mail-Besitzers (UUID-Format) createdAt | string | E-Mail-Erstellungszeit (ISO 8601-Format) expiresAt | string | E-Mail-Ablaufzeit (ISO 8601-Format) ### Antwortbeispiel [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] ## E-Mail löschen Die angegebene E-Mail-Adresse löschen. ### Anfrage [Code (bash)] DELETE /api/emails/{emailId} [/Code] ### Anfrageparameter Parameter | Typ | Erforderlich | Beschreibung ----------- | ----- | -------------- | -------------- emailId | string | Ja | E-Mail-ID (Pfad-Parameter) ### Anfragebeispiel [Code (bash)] curl -X DELETE "https://chat-tempmail.com/api/emails/99fadf12-6826-490a-9c6c-b0b528d4a8e0" \ -H "X-API-Key: YOUR_API_KEY" [/Code] ### Antwortparameter Parameter | Typ | Beschreibung ----------- | ----- | -------------- success | boolean | Ob die Löschung erfolgreich war ### Antwortbeispiel [Code (json)] { "success": true } [/Code] --- ## Nachrichten API Nachrichten verwalten ## Nachrichtenliste abrufen Alle Nachrichten in der angegebenen E-Mail-Adresse abrufen. ### Anfrage [Code (bash)] GET /api/emails/{emailId} [/Code] ### Anfrageparameter Parameter | Typ | Erforderlich | Beschreibung ----------- | ----- | -------------- | -------------- emailId | string | Ja | E-Mail-ID (Pfad-Parameter) cursor | string | Nein | Paginierungs-Cursor (Query-Parameter), nextCursor aus vorheriger Antwort abrufen ### Anfragebeispiel [Code (bash)] curl "https://chat-tempmail.com/api/emails/c2c4f894-c672-4d5b-a918-abca95aff1f7" \ -H "X-API-Key: YOUR_API_KEY" [/Code] ### Antwortparameter Parameter | Typ | Beschreibung ----------- | ----- | -------------- messages | array | Nachrichtenliste (max. 20 Elemente pro Anfrage) nextCursor | string | Nächste Seiten-Cursor für weitere Daten total | number | Gesamtanzahl der Nachrichten ### Nachrichten-Objekte im messages-Array Parameter | Typ | Beschreibung ----------- | ----- | -------------- id | string | Eindeutige Kennung der Nachricht (UUID-Format) from_address | string | Absenderadresse subject | string | Nachrichtenbetreff received_at | number | Empfangszeit (Unix-Zeitstempel in Millisekunden) ### Antwortbeispiel [Code (json)] { "messages": [ { "id": "fd13a8df-1465-4fbc-a612-ca7311c31ff2", "from_address": "sender1@example.com", "subject": "Test Nachricht 1 - xJOK2h", "received_at": 1745224245084 } ], "nextCursor": "eyJ0aW1lc3RhbXAiOjE3NDUxNTU4NDUwODQsImlkIjoiNjNmNzFlODYtOGE1NC00ZDQ0LTk5ZWYtN2QzNTBhMTQ4M2JiIn0=", "total": 50 } [/Code] ## Nachrichtendetails abrufen Detaillierten Inhalt der angegebenen Nachricht abrufen. ### Anfrage [Code (bash)] GET /api/emails/{emailId}/{messageId} [/Code] ### Anfrageparameter Parameter | Typ | Erforderlich | Beschreibung ----------- | ----- | -------------- | -------------- emailId | string | Ja | E-Mail-ID (Pfad-Parameter) messageId | string | Ja | Nachrichten-ID (Pfad-Parameter) ### Anfragebeispiel [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] ### Antwortparameter Parameter | Typ | Beschreibung ----------- | ----- | -------------- message | object | Nachrichtendetails ### message-Objektfelder Parameter | Typ | Beschreibung ----------- | ----- | -------------- id | string | Eindeutige Kennung der Nachricht (UUID-Format) from_address | string | Absenderadresse subject | string | Nachrichtenbetreff content | string | Nachricht als Klartext-Inhalt html | string | Nachricht als HTML-Inhalt (kann leer sein) received_at | number | Empfangszeit (Unix-Zeitstempel in Millisekunden) ### Antwortbeispiel [Code (json)] { "message": { "id": "fd13a8df-1465-4fbc-a612-ca7311c31ff2", "from_address": "sender1@example.com", "subject": "Test Nachricht 1 - xJOK2h", "content": "Test Nachricht 1\n\nDies ist der Inhalt von Test Nachricht 1.\n\nMit freundlichen Grüßen,\nAbsender 1", "html": "
\n

Test Nachricht 1

\n
", "received_at": 1745224245084 } } [/Code] ## Nachricht löschen Die angegebene Nachricht löschen. ### Anfrage [Code (bash)] DELETE /api/emails/{emailId}/{messageId} [/Code] ### Anfrageparameter Parameter | Typ | Erforderlich | Beschreibung ----------- | ----- | -------------- | -------------- emailId | string | Ja | E-Mail-ID (Pfad-Parameter) messageId | string | Ja | Nachrichten-ID (Pfad-Parameter) ### Anfragebeispiel [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] ### Antwortparameter Parameter | Typ | Beschreibung ----------- | ----- | -------------- success | boolean | Ob die Löschung erfolgreich war ### Antwortbeispiel [Code (json)] { "success": true } [/Code] --- ## Webhook Push Webhook konfigurieren, um Push-Benachrichtigungen für Nachrichten zu erhalten ## Webhook-Konfiguration abrufen Aktuelle Webhook-Konfigurationsinformationen abrufen. ### Anfrage [Code (bash)] GET /api/webhook [/Code] ### Anfragebeispiel [Code (bash)] curl https://chat-tempmail.com/api/webhook \ -H "X-API-Key: YOUR_API_KEY" [/Code] ### Antwortparameter Parameter | Typ | Beschreibung ----------- | ----- | -------------- url | string | Webhook-URL-Adresse (kann leerer String sein) enabled | boolean | Ob Webhook aktiviert ist ### Antwortbeispiel [Code (json)] { "url": "https://your-server.com/webhook", "enabled": true } [/Code] ## Webhook konfigurieren Webhook-Konfiguration setzen oder aktualisieren. ### Anfrage [Code (bash)] POST /api/webhook [/Code] ### Anfrageparameter Parameter | Typ | Erforderlich | Beschreibung ----------- | ----- | -------------- | -------------- url | string | Ja | Webhook-URL-Adresse (muss gültige HTTP/HTTPS-URL sein) enabled | boolean | Ja | Ob Webhook aktiviert werden soll ### Anfragebeispiel [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] ### Antwortparameter Parameter | Typ | Beschreibung ----------- | ----- | -------------- success | boolean | Ob die Konfiguration erfolgreich war ### Antwortbeispiel [Code (json)] { "success": true } [/Code] ## Webhook-Ereignisse Wenn eine neue Nachricht ankommt, sendet das System eine POST-Anfrage an Ihre konfigurierte URL. ### Empfangenes Datenformat Anfrage-Header: - Content-Type: application/json - X-Webhook-Event: new_message ### Webhook Push-Daten Parameter | Typ | Beschreibung ----------- | ----- | -------------- emailId | string | E-Mail-ID, die die Nachricht erhalten hat (UUID-Format) messageId | string | Neue Nachrichten-ID (UUID-Format) fromAddress | string | Absenderadresse subject | string | Nachrichtenbetreff content | string | Nachricht als Klartext-Inhalt html | string | Nachricht als HTML-Inhalt (kann leer sein) receivedAt | string | Nachrichtenempfangszeit (ISO 8601-Format) toAddress | string | E-Mail-Adresse, die die Nachricht erhalten hat ### Push-Datenbeispiel [Code (json)] { "emailId": "c2c4f894-c672-4d5b-a918-abca95aff1f7", "messageId": "fd13a8df-1465-4fbc-a612-ca7311c31ff2", "fromAddress": "sender@example.com", "subject": "Test Nachricht", "content": "Nachricht als Klartext-Inhalt", "html": "
Nachricht als HTML-Inhalt
", "receivedAt": "2025-01-21T08:30:45.084Z", "toAddress": "test@chat-tempmail.com" } [/Code] ### Antwortanforderungen Ihr Server sollte einen 2xx-Statuscode zurückgeben, um den erfolgreichen Empfang anzuzeigen. Wenn ein Nicht-2xx-Statuscode zurückgegeben wird, kann das System versuchen, erneut zu senden. Empfohlene Antwort: [Code (json)] HTTP/1.1 200 OK Content-Type: application/json { "received": true } [/Code] ### Wichtige Hinweise - Stellen Sie sicher, dass Ihre Webhook-URL erreichbar ist - Es wird empfohlen, die Integrität der Push-Daten auf Ihrer Serverseite zu verifizieren - Das System sendet Webhook-Pushes sofort, wenn Nachrichten ankommen - Falls Pushes fehlschlagen, kann das System erneut versuchen, daher stellen Sie sicher, dass Ihre Schnittstelle idempotent ist ---