## Аутентификация Узнайте, как получить и использовать 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 | Да | Время истечения (миллисекунды)
Доступные значения:
- 3600000 (1 час)
- 86400000 (1 день)
- 259200000 (3 дня)
- 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": "
\n

Test Message 1

\n
", "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] --- ## Webhook Push Настройте webhook для получения push-уведомлений о сообщениях ## Получить конфигурацию Webhook Получить информацию о текущей конфигурации webhook. ### Запрос [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-адрес webhook (может быть пустой строкой) enabled | boolean | Включен ли webhook ### Пример ответа [Code (json)] { "url": "https://your-server.com/webhook", "enabled": true } [/Code] ## Настроить Webhook Установить или обновить конфигурацию webhook. ### Запрос [Code (bash)] POST /api/webhook [/Code] ### Параметры запроса Параметр | Тип | Обязательный | Описание ---------- | ----- | -------------- | ---------- url | string | Да | URL-адрес webhook (должен быть действительным HTTP/HTTPS URL) enabled | boolean | Да | Включить ли webhook ### Пример запроса [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] ## События Webhook Когда приходит новое сообщение, система отправит POST-запрос на ваш настроенный URL. ### Формат получаемых данных Заголовки запроса: - Content-Type: application/json - X-Webhook-Event: new_message ### Данные push-уведомления Webhook Параметр | Тип | Описание ---------- | ----- | ---------- emailId | string | ID электронной почты, которая получила сообщение (формат UUID) messageId | string | ID нового сообщения (формат UUID) fromAddress | string | Адрес отправителя subject | string | Тема сообщения content | string | Текстовое содержимое сообщения html | string | HTML-содержимое сообщения (может быть пустым) receivedAt | string | Время получения сообщения (формат ISO 8601) toAddress | string | Адрес электронной почты, который получил сообщение ### Пример push-данных [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] ### Требования к ответу Ваш сервер должен вернуть статус-код 2xx для указания успешного получения. Если возвращается статус-код не 2xx, система может повторить отправку. Рекомендуемый ответ: [Code (json)] HTTP/1.1 200 OK Content-Type: application/json { "received": true } [/Code] ### Важные примечания - Убедитесь, что ваш URL webhook доступен - Рекомендуется проверять целостность push-данных на стороне вашего сервера - Система будет отправлять webhook push-уведомления немедленно при поступлении сообщений - Если push-уведомления не удаются, система может повторить попытку, поэтому убедитесь, что ваш интерфейс идемпотентен ---