## Pengesahan Pelajari cara mendapatkan dan menggunakan kunci API ## Dapatkan Kunci API Sebelum menggunakan API, anda perlu mendapatkan kunci API. Anda boleh mencipta kunci API anda di halaman Profil. ### Menggunakan Kunci API Sertakan kunci API anda dalam pengepala permintaan untuk semua permintaan API: [Code (bash)] X-API-Key: YOUR_API_KEY [/Code] ### Nota Penting - Simpan kunci API anda dengan selamat dan jangan dedahkan di tempat awam - Kunci API mempunyai kebenaran yang sama dengan akaun anda, gunakan dengan berhati-hati - Jika kunci API anda dikompromi, segera hasilkan semula yang baharu di halaman Profil anda --- ## API E-mel Cipta dan uruskan e-mel ## Dapatkan Domain Tersedia Dapatkan semua domain e-mel yang tersedia dalam sistem. ### Permintaan [Code (bash)] GET /api/email/domains [/Code] ### Contoh Permintaan [Code (bash)] curl https://chat-tempmail.com/api/email/domains \ -H "X-API-Key: YOUR_API_KEY" [/Code] ### Parameter Respons Parameter | Jenis | Penerangan ----------- | ------ | ------------ domains | array | Senarai domain e-mel yang tersedia ### Contoh Respons [Code (json)] { "domains": [ "chat-tempmail.com", "example.com", "other-domain.com" ] } [/Code] ## Cipta E-mel Cipta alamat e-mel sementara baharu. ### Permintaan [Code (bash)] POST /api/emails/generate [/Code] ### Parameter Permintaan Parameter | Jenis | Diperlukan | Penerangan ----------- | ------ | ------------ | ------------- name | string | Ya | Awalan e-mel expiryTime | number | Ya | Masa tamat tempoh (milisaat)
Nilai tersedia:
- 3600000 (1 jam)
- 86400000 (1 hari)
- 259200000 (3 hari)
- 0 (kekal) domain | string | Ya | Domain e-mel ### Contoh Permintaan [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] ### Parameter Respons Parameter | Jenis | Penerangan ----------- | ------ | ------------ id | string | Pengecam unik e-mel (format UUID) email | string | Alamat e-mel yang dicipta (alamat e-mel penuh) ### Contoh Respons [Code (json)] { "id": "c2c4f894-c672-4d5b-a918-abca95aff1f7", "email": "test@chat-tempmail.com" } [/Code] ## Dapatkan Senarai E-mel Dapatkan semua alamat e-mel di bawah akaun anda. ### Permintaan [Code (bash)] GET /api/emails [/Code] ### Parameter Permintaan Parameter | Jenis | Diperlukan | Penerangan ----------- | ------ | ------------ | ------------- cursor | string | Tidak | Kursor pagination, dapatkan nextCursor dari respons sebelumnya ### Contoh Permintaan [Code (bash)] curl https://chat-tempmail.com/api/emails \ -H "X-API-Key: YOUR_API_KEY" [/Code] ### Parameter Respons Parameter | Jenis | Penerangan ----------- | ------ | ------------ emails | array | Senarai e-mel (maksimum 20 item setiap permintaan) nextCursor | string | Kursor halaman seterusnya untuk mendapatkan lebih banyak data total | number | Jumlah keseluruhan e-mel ### Objek E-mel dalam Array emails Parameter | Jenis | Penerangan ----------- | ------ | ------------ id | string | Pengecam unik e-mel (format UUID) address | string | Alamat e-mel (alamat e-mel penuh) userId | string | ID pengguna yang memiliki e-mel (format UUID) createdAt | string | Masa penciptaan e-mel (format ISO 8601) expiresAt | string | Masa tamat tempoh e-mel (format ISO 8601) ### Contoh Respons [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] ## Padam E-mel Padam alamat e-mel yang ditentukan. ### Permintaan [Code (bash)] DELETE /api/emails/{emailId} [/Code] ### Parameter Permintaan Parameter | Jenis | Diperlukan | Penerangan ----------- | ------ | ------------ | ------------- emailId | string | Ya | ID e-mel (parameter laluan) ### Contoh Permintaan [Code (bash)] curl -X DELETE "https://chat-tempmail.com/api/emails/99fadf12-6826-490a-9c6c-b0b528d4a8e0" \ -H "X-API-Key: YOUR_API_KEY" [/Code] ### Parameter Respons Parameter | Jenis | Penerangan ----------- | ------ | ------------ success | boolean | Sama ada pemadaman berjaya ### Contoh Respons [Code (json)] { "success": true } [/Code] --- ## API Mesej Uruskan mesej ## Dapatkan Senarai Mesej Dapatkan semua mesej dalam alamat e-mel yang ditentukan. ### Permintaan [Code (bash)] GET /api/emails/{emailId} [/Code] ### Parameter Permintaan Parameter | Jenis | Diperlukan | Penerangan ----------- | ------ | ------------ | ------------- emailId | string | Ya | ID e-mel (parameter laluan) cursor | string | Tidak | Kursor pagination (parameter pertanyaan), dapatkan nextCursor dari respons sebelumnya ### Contoh Permintaan [Code (bash)] curl "https://chat-tempmail.com/api/emails/c2c4f894-c672-4d5b-a918-abca95aff1f7" \ -H "X-API-Key: YOUR_API_KEY" [/Code] ### Parameter Respons Parameter | Jenis | Penerangan ----------- | ------ | ------------ messages | array | Senarai mesej (maksimum 20 item setiap permintaan) nextCursor | string | Kursor halaman seterusnya untuk mendapatkan lebih banyak data total | number | Jumlah keseluruhan mesej ### Objek Mesej dalam Array messages Parameter | Jenis | Penerangan ----------- | ------ | ------------ id | string | Pengecam unik mesej (format UUID) from_address | string | Alamat penghantar subject | string | Subjek mesej received_at | number | Masa diterima (Unix timestamp dalam milisaat) ### Contoh Respons [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] ## Dapatkan Butiran Mesej Dapatkan kandungan terperinci mesej yang ditentukan. ### Permintaan [Code (bash)] GET /api/emails/{emailId}/{messageId} [/Code] ### Parameter Permintaan Parameter | Jenis | Diperlukan | Penerangan ----------- | ------ | ------------ | ------------- emailId | string | Ya | ID e-mel (parameter laluan) messageId | string | Ya | ID mesej (parameter laluan) ### Contoh Permintaan [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] ### Parameter Respons Parameter | Jenis | Penerangan ----------- | ------ | ------------ message | object | Butiran mesej ### Medan Objek message Parameter | Jenis | Penerangan ----------- | ------ | ------------ id | string | Pengecam unik mesej (format UUID) from_address | string | Alamat penghantar subject | string | Subjek mesej content | string | Kandungan teks biasa mesej html | string | Kandungan HTML mesej (mungkin kosong) received_at | number | Masa diterima (Unix timestamp dalam milisaat) ### Contoh Respons [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": "
\n

Test Message 1

\n
", "received_at": 1745224245084 } } [/Code] ## Padam Mesej Padam mesej yang ditentukan. ### Permintaan [Code (bash)] DELETE /api/emails/{emailId}/{messageId} [/Code] ### Parameter Permintaan Parameter | Jenis | Diperlukan | Penerangan ----------- | ------ | ------------ | ------------- emailId | string | Ya | ID e-mel (parameter laluan) messageId | string | Ya | ID mesej (parameter laluan) ### Contoh Permintaan [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] ### Parameter Respons Parameter | Jenis | Penerangan ----------- | ------ | ------------ success | boolean | Sama ada pemadaman berjaya ### Contoh Respons [Code (json)] { "success": true } [/Code] --- ## Tolakan Webhook Konfigurasi webhook untuk menerima notifikasi tolakan mesej ## Dapatkan Konfigurasi Webhook Dapatkan maklumat konfigurasi webhook semasa. ### Permintaan [Code (bash)] GET /api/webhook [/Code] ### Contoh Permintaan [Code (bash)] curl https://chat-tempmail.com/api/webhook \ -H "X-API-Key: YOUR_API_KEY" [/Code] ### Parameter Respons Parameter | Jenis | Penerangan ----------- | ------ | ------------ url | string | Alamat URL webhook (mungkin string kosong) enabled | boolean | Sama ada webhook didayakan ### Contoh Respons [Code (json)] { "url": "https://your-server.com/webhook", "enabled": true } [/Code] ## Konfigurasi Webhook Tetapkan atau kemas kini konfigurasi webhook. ### Permintaan [Code (bash)] POST /api/webhook [/Code] ### Parameter Permintaan Parameter | Jenis | Diperlukan | Penerangan ----------- | ------ | ------------ | ------------- url | string | Ya | Alamat URL webhook (mesti URL HTTP/HTTPS yang sah) enabled | boolean | Ya | Sama ada untuk mendayakan webhook ### Contoh Permintaan [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] ### Parameter Respons Parameter | Jenis | Penerangan ----------- | ------ | ------------ success | boolean | Sama ada konfigurasi berjaya ### Contoh Respons [Code (json)] { "success": true } [/Code] ## Acara Webhook Apabila mesej baharu tiba, sistem akan menghantar permintaan POST ke URL yang dikonfigurasi anda. ### Format Data Diterima Pengepala Permintaan: - Content-Type: application/json - X-Webhook-Event: new_message ### Data Tolakan Webhook Parameter | Jenis | Penerangan ----------- | ------ | ------------ emailId | string | ID e-mel yang menerima mesej (format UUID) messageId | string | ID mesej baharu (format UUID) fromAddress | string | Alamat penghantar subject | string | Subjek mesej content | string | Kandungan teks biasa mesej html | string | Kandungan HTML mesej (mungkin kosong) receivedAt | string | Masa mesej diterima (format ISO 8601) toAddress | string | Alamat e-mel yang menerima mesej ### Contoh Data Tolakan [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": "
Message HTML content
", "receivedAt": "2025-01-21T08:30:45.084Z", "toAddress": "test@chat-tempmail.com" } [/Code] ### Keperluan Respons Pelayan anda harus mengembalikan kod status 2xx untuk menunjukkan penerimaan berjaya. Jika kod status bukan 2xx dikembalikan, sistem mungkin akan mencuba menghantar semula. Respons Disyorkan: [Code (json)] HTTP/1.1 200 OK Content-Type: application/json { "received": true } [/Code] ### Nota Penting - Pastikan URL webhook anda boleh diakses - Adalah disyorkan untuk mengesahkan integriti data tolakan di sisi pelayan anda - Sistem akan menghantar tolakan webhook dengan segera apabila mesej tiba - Jika tolakan gagal, sistem mungkin akan mencuba semula, jadi pastikan antara muka anda idempotent ---