## Authenticatie Leer hoe u API-sleutels kunt verkrijgen en gebruiken ## API-sleutel verkrijgen Voordat u de API gebruikt, moet u een API-sleutel verkrijgen. U kunt uw API-sleutel aanmaken op de Profiel pagina. ### API-sleutel gebruiken Voeg uw API-sleutel toe aan de request headers voor alle API-verzoeken: [Code (bash)] X-API-Key: YOUR_API_KEY [/Code] ### Belangrijke opmerkingen - Houd uw API-sleutel veilig en deel deze niet op openbare plaatsen - De API-sleutel heeft dezelfde machtigingen als uw account, gebruik deze voorzichtig - Als uw API-sleutel gecompromitteerd is, genereer onmiddellijk een nieuwe op uw Profiel pagina --- ## E-mail API E-mails aanmaken en beheren ## Beschikbare domeinen ophalen Haal alle beschikbare e-maildomeinen in het systeem op. ### Verzoek [Code (bash)] GET /api/email/domains [/Code] ### Verzoek voorbeeld [Code (bash)] curl https://chat-tempmail.com/api/email/domains \ -H "X-API-Key: YOUR_API_KEY" [/Code] ### Antwoord parameters Parameter | Type | Beschrijving ----------- | ------ | ------------- domains | array | Lijst van beschikbare e-maildomeinen ### Antwoord voorbeeld [Code (json)] { "domains": [ "chat-tempmail.com", "example.com", "other-domain.com" ] } [/Code] ## E-mail aanmaken Maak een nieuw tijdelijk e-mailadres aan. ### Verzoek [Code (bash)] POST /api/emails/generate [/Code] ### Verzoek parameters Parameter | Type | Vereist | Beschrijving ----------- | ------ | --------- | ------------- name | string | Ja | E-mail voorvoegsel expiryTime | number | Ja | Vervaltijd (milliseconden)
Beschikbare waarden:
- 3600000 (1 uur)
- 86400000 (1 dag)
- 259200000 (3 dagen)
- 0 (permanent) domain | string | Ja | E-mail domein ### Verzoek voorbeeld [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] ### Antwoord parameters Parameter | Type | Beschrijving ----------- | ------ | ------------- id | string | Unieke identifier van de e-mail (UUID formaat) email | string | Aangemaakt e-mailadres (volledig e-mailadres) ### Antwoord voorbeeld [Code (json)] { "id": "c2c4f894-c672-4d5b-a918-abca95aff1f7", "email": "test@chat-tempmail.com" } [/Code] ## E-maillijst ophalen Haal alle e-mailadressen onder uw account op. ### Verzoek [Code (bash)] GET /api/emails [/Code] ### Verzoek parameters Parameter | Type | Vereist | Beschrijving ----------- | ------ | --------- | ------------- cursor | string | Nee | Paginering cursor, haal nextCursor op uit vorig antwoord ### Verzoek voorbeeld [Code (bash)] curl https://chat-tempmail.com/api/emails \ -H "X-API-Key: YOUR_API_KEY" [/Code] ### Antwoord parameters Parameter | Type | Beschrijving ----------- | ------ | ------------- emails | array | E-maillijst (max 20 items per verzoek) nextCursor | string | Volgende pagina cursor voor meer gegevens total | number | Totaal aantal e-mails ### E-mail objecten in emails array Parameter | Type | Beschrijving ----------- | ------ | ------------- id | string | Unieke identifier van de e-mail (UUID formaat) address | string | E-mailadres (volledig e-mailadres) userId | string | Gebruiker ID die eigenaar is van de e-mail (UUID formaat) createdAt | string | E-mail aanmaaktijd (ISO 8601 formaat) expiresAt | string | E-mail vervaltijd (ISO 8601 formaat) ### Antwoord voorbeeld [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 verwijderen Verwijder het opgegeven e-mailadres. ### Verzoek [Code (bash)] DELETE /api/emails/{emailId} [/Code] ### Verzoek parameters Parameter | Type | Vereist | Beschrijving ----------- | ------ | --------- | ------------- emailId | string | Ja | E-mail ID (pad parameter) ### Verzoek voorbeeld [Code (bash)] curl -X DELETE "https://chat-tempmail.com/api/emails/99fadf12-6826-490a-9c6c-b0b528d4a8e0" \ -H "X-API-Key: YOUR_API_KEY" [/Code] ### Antwoord parameters Parameter | Type | Beschrijving ----------- | ------ | ------------- success | boolean | Of verwijdering succesvol was ### Antwoord voorbeeld [Code (json)] { "success": true } [/Code] --- ## Bericht API Berichten beheren ## Berichtenlijst ophalen Haal alle berichten in het opgegeven e-mailadres op. ### Verzoek [Code (bash)] GET /api/emails/{emailId} [/Code] ### Verzoek parameters Parameter | Type | Vereist | Beschrijving ----------- | ------ | --------- | ------------- emailId | string | Ja | E-mail ID (pad parameter) cursor | string | Nee | Paginering cursor (query parameter), haal nextCursor op uit vorig antwoord ### Verzoek voorbeeld [Code (bash)] curl "https://chat-tempmail.com/api/emails/c2c4f894-c672-4d5b-a918-abca95aff1f7" \ -H "X-API-Key: YOUR_API_KEY" [/Code] ### Antwoord parameters Parameter | Type | Beschrijving ----------- | ------ | ------------- messages | array | Berichtenlijst (max 20 items per verzoek) nextCursor | string | Volgende pagina cursor voor meer gegevens total | number | Totaal aantal berichten ### Bericht objecten in messages array Parameter | Type | Beschrijving ----------- | ------ | ------------- id | string | Unieke identifier van het bericht (UUID formaat) from_address | string | Afzender adres subject | string | Bericht onderwerp received_at | number | Ontvangsttijd (Unix timestamp in milliseconden) ### Antwoord voorbeeld [Code (json)] { "messages": [ { "id": "fd13a8df-1465-4fbc-a612-ca7311c31ff2", "from_address": "sender1@example.com", "subject": "Test Bericht 1 - xJOK2h", "received_at": 1745224245084 } ], "nextCursor": "eyJ0aW1lc3RhbXAiOjE3NDUxNTU4NDUwODQsImlkIjoiNjNmNzFlODYtOGE1NC00ZDQ0LTk5ZWYtN2QzNTBhMTQ4M2JiIn0=", "total": 50 } [/Code] ## Berichtdetails ophalen Haal gedetailleerde inhoud van het opgegeven bericht op. ### Verzoek [Code (bash)] GET /api/emails/{emailId}/{messageId} [/Code] ### Verzoek parameters Parameter | Type | Vereist | Beschrijving ----------- | ------ | --------- | ------------- emailId | string | Ja | E-mail ID (pad parameter) messageId | string | Ja | Bericht ID (pad parameter) ### Verzoek voorbeeld [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] ### Antwoord parameters Parameter | Type | Beschrijving ----------- | ------ | ------------- message | object | Berichtdetails ### message object velden Parameter | Type | Beschrijving ----------- | ------ | ------------- id | string | Unieke identifier van het bericht (UUID formaat) from_address | string | Afzender adres subject | string | Bericht onderwerp content | string | Bericht platte tekst inhoud html | string | Bericht HTML inhoud (kan leeg zijn) received_at | number | Ontvangsttijd (Unix timestamp in milliseconden) ### Antwoord voorbeeld [Code (json)] { "message": { "id": "fd13a8df-1465-4fbc-a612-ca7311c31ff2", "from_address": "sender1@example.com", "subject": "Test Bericht 1 - xJOK2h", "content": "Test Bericht 1\n\nDit is test bericht 1 inhoud.\n\nMet vriendelijke groet,\nAfzender 1", "html": "
\n

Test Bericht 1

\n
", "received_at": 1745224245084 } } [/Code] ## Bericht verwijderen Verwijder het opgegeven bericht. ### Verzoek [Code (bash)] DELETE /api/emails/{emailId}/{messageId} [/Code] ### Verzoek parameters Parameter | Type | Vereist | Beschrijving ----------- | ------ | --------- | ------------- emailId | string | Ja | E-mail ID (pad parameter) messageId | string | Ja | Bericht ID (pad parameter) ### Verzoek voorbeeld [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] ### Antwoord parameters Parameter | Type | Beschrijving ----------- | ------ | ------------- success | boolean | Of verwijdering succesvol was ### Antwoord voorbeeld [Code (json)] { "success": true } [/Code] --- ## Webhook Push Configureer webhook om bericht push notificaties te ontvangen ## Webhook configuratie ophalen Haal huidige webhook configuratie informatie op. ### Verzoek [Code (bash)] GET /api/webhook [/Code] ### Verzoek voorbeeld [Code (bash)] curl https://chat-tempmail.com/api/webhook \ -H "X-API-Key: YOUR_API_KEY" [/Code] ### Antwoord parameters Parameter | Type | Beschrijving ----------- | ------ | ------------- url | string | Webhook URL adres (kan lege string zijn) enabled | boolean | Of webhook is ingeschakeld ### Antwoord voorbeeld [Code (json)] { "url": "https://your-server.com/webhook", "enabled": true } [/Code] ## Webhook configureren Stel webhook configuratie in of werk deze bij. ### Verzoek [Code (bash)] POST /api/webhook [/Code] ### Verzoek parameters Parameter | Type | Vereist | Beschrijving ----------- | ------ | --------- | ------------- url | string | Ja | Webhook URL adres (moet geldige HTTP/HTTPS URL zijn) enabled | boolean | Ja | Of webhook moet worden ingeschakeld ### Verzoek voorbeeld [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] ### Antwoord parameters Parameter | Type | Beschrijving ----------- | ------ | ------------- success | boolean | Of configuratie succesvol was ### Antwoord voorbeeld [Code (json)] { "success": true } [/Code] ## Webhook gebeurtenissen Wanneer een nieuw bericht arriveert, stuurt het systeem een POST verzoek naar uw geconfigureerde URL. ### Ontvangen gegevens formaat Request Headers: - Content-Type: application/json - X-Webhook-Event: new_message ### Webhook push gegevens Parameter | Type | Beschrijving ----------- | ------ | ------------- emailId | string | E-mail ID die het bericht ontving (UUID formaat) messageId | string | Nieuw bericht ID (UUID formaat) fromAddress | string | Afzender adres subject | string | Bericht onderwerp content | string | Bericht platte tekst inhoud html | string | Bericht HTML inhoud (kan leeg zijn) receivedAt | string | Bericht ontvangsttijd (ISO 8601 formaat) toAddress | string | E-mailadres dat het bericht ontving ### Push gegevens voorbeeld [Code (json)] { "emailId": "c2c4f894-c672-4d5b-a918-abca95aff1f7", "messageId": "fd13a8df-1465-4fbc-a612-ca7311c31ff2", "fromAddress": "sender@example.com", "subject": "Test Bericht", "content": "Bericht platte tekst inhoud", "html": "
Bericht HTML inhoud
", "receivedAt": "2025-01-21T08:30:45.084Z", "toAddress": "test@chat-tempmail.com" } [/Code] ### Antwoord vereisten Uw server moet een 2xx status code retourneren om succesvolle ontvangst aan te geven. Als een niet-2xx status code wordt geretourneerd, kan het systeem opnieuw proberen te verzenden. Aanbevolen antwoord: [Code (json)] HTTP/1.1 200 OK Content-Type: application/json { "received": true } [/Code] ### Belangrijke opmerkingen - Zorg ervoor dat uw webhook URL toegankelijk is - Het wordt aanbevolen om de integriteit van push gegevens op uw server kant te verifiëren - Het systeem stuurt webhook pushes onmiddellijk wanneer berichten arriveren - Als pushes falen, kan het systeem opnieuw proberen, dus zorg ervoor dat uw interface idempotent is ---