Wiadomość testowa 1

## Uwierzytelnianie

Dowiedz się, jak uzyskać i używać kluczy API

## Uzyskiwanie klucza API

Przed użyciem API musisz uzyskać klucz API. Możesz utworzyć swój klucz API na stronie profilu.

### Używanie klucza API

Dodaj swój klucz API do nagłówków żądania dla wszystkich wywołań API:

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

### Ważne uwagi

- Przechowuj swój klucz API w bezpiecznym miejscu i nie udostępniaj go publicznie
- Klucz API ma takie same uprawnienia jak Twoje konto, używaj go ostrożnie
- Jeśli Twój klucz API został skompromitowany, natychmiast wygeneruj nowy na stronie profilu

---

## API E-mail

Tworzenie i zarządzanie e-mailami

## Pobieranie dostępnych domen

Pobierz wszystkie dostępne domeny e-mail w systemie.

### Żądanie

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

### Przykład żądania

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

### Parametry odpowiedzi

Parametr | Typ | Opis
---------- | ----- | ------
domains | array | Lista dostępnych domen e-mail

### Przykład odpowiedzi

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

## Tworzenie e-maila

Utwórz nowy tymczasowy adres e-mail.

### Żądanie

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

### Parametry żądania

Parametr | Typ | Wymagane | Opis
---------- | ----- | ---------- | ------
name | string | Tak | Prefiks e-maila
expiryTime | number | Tak | Czas wygaśnięcia (milisekundy)<br/>Dostępne wartości:<br/>- 3600000 (1 godzina)<br/>- 86400000 (1 dzień)<br/>- 259200000 (3 dni)<br/>- 0 (permanentny)
domain | string | Tak | Domena e-mail

### Przykład żądania

[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]

### Parametry odpowiedzi

Parametr | Typ | Opis
---------- | ----- | ------
id | string | Unikalny identyfikator e-maila (format UUID)
email | string | Utworzony adres e-mail (pełny adres e-mail)

### Przykład odpowiedzi

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

## Pobieranie listy e-maili

Pobierz wszystkie adresy e-mail w ramach Twojego konta.

### Żądanie

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

### Parametry żądania

Parametr | Typ | Wymagane | Opis
---------- | ----- | ---------- | ------
cursor | string | Nie | Kursor paginacji, pobierz nextCursor z poprzedniej odpowiedzi

### Przykład żądania

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

### Parametry odpowiedzi

Parametr | Typ | Opis
---------- | ----- | ------
emails | array | Lista e-maili (maksymalnie 20 elementów na żądanie)
nextCursor | string | Kursor następnej strony dla dalszych danych
total | number | Całkowita liczba e-maili

### Obiekty e-mail w tablicy emails

Parametr | Typ | Opis
---------- | ----- | ------
id | string | Unikalny identyfikator e-maila (format UUID)
address | string | Adres e-mail (pełny adres e-mail)
userId | string | ID użytkownika właściciela e-maila (format UUID)
createdAt | string | Czas utworzenia e-maila (format ISO 8601)
expiresAt | string | Czas wygaśnięcia e-maila (format ISO 8601)

### Przykład odpowiedzi

[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]

## Usuwanie e-maila

Usuń określony adres e-mail.

### Żądanie

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

### Parametry żądania

Parametr | Typ | Wymagane | Opis
---------- | ----- | ---------- | ------
emailId | string | Tak | ID e-maila (parametr ścieżki)

### Przykład żądania

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

### Parametry odpowiedzi

Parametr | Typ | Opis
---------- | ----- | ------
success | boolean | Czy usunięcie powiodło się

### Przykład odpowiedzi

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

---

## API Wiadomości

Zarządzanie wiadomościami

## Pobieranie listy wiadomości

Pobierz wszystkie wiadomości w określonym adresie e-mail.

### Żądanie

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

### Parametry żądania

Parametr | Typ | Wymagane | Opis
---------- | ----- | ---------- | ------
emailId | string | Tak | ID e-maila (parametr ścieżki)
cursor | string | Nie | Kursor paginacji (parametr zapytania), pobierz nextCursor z poprzedniej odpowiedzi

### Przykład żądania

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

### Parametry odpowiedzi

Parametr | Typ | Opis
---------- | ----- | ------
messages | array | Lista wiadomości (maksymalnie 20 elementów na żądanie)
nextCursor | string | Kursor następnej strony dla dalszych danych
total | number | Całkowita liczba wiadomości

### Obiekty wiadomości w tablicy messages

Parametr | Typ | Opis
---------- | ----- | ------
id | string | Unikalny identyfikator wiadomości (format UUID)
from_address | string | Adres nadawcy
subject | string | Temat wiadomości
received_at | number | Czas odbioru (znacznik czasowy Unix w milisekundach)

### Przykład odpowiedzi

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

## Pobieranie szczegółów wiadomości

Pobierz szczegółową zawartość określonej wiadomości.

### Żądanie

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

### Parametry żądania

Parametr | Typ | Wymagane | Opis
---------- | ----- | ---------- | ------
emailId | string | Tak | ID e-maila (parametr ścieżki)
messageId | string | Tak | ID wiadomości (parametr ścieżki)

### Przykład żądania

[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]

### Parametry odpowiedzi

Parametr | Typ | Opis
---------- | ----- | ------
message | object | Szczegóły wiadomości

### Pola obiektu message

Parametr | Typ | Opis
---------- | ----- | ------
id | string | Unikalny identyfikator wiadomości (format UUID)
from_address | string | Adres nadawcy
subject | string | Temat wiadomości
content | string | Zawartość wiadomości jako zwykły tekst
html | string | Zawartość wiadomości jako HTML (może być pusta)
received_at | number | Czas odbioru (znacznik czasowy Unix w milisekundach)

### Przykład odpowiedzi

[Code (json)]
{
  "message": {
    "id": "fd13a8df-1465-4fbc-a612-ca7311c31ff2",
    "from_address": "sender1@example.com",
    "subject": "Wiadomość testowa 1 - xJOK2h",
    "content": "Wiadomość testowa 1\n\nTo jest zawartość wiadomości testowej 1.\n\nZ poważaniem,\nNadawca 1",
    "html": "<div>\n<h1>Wiadomość testowa 1</h1>\n </div>",
    "received_at": 1745224245084
  }
}
[/Code]

## Usuwanie wiadomości

Usuń określoną wiadomość.

### Żądanie

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

### Parametry żądania

Parametr | Typ | Wymagane | Opis
---------- | ----- | ---------- | ------
emailId | string | Tak | ID e-maila (parametr ścieżki)
messageId | string | Tak | ID wiadomości (parametr ścieżki)

### Przykład żądania

[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]

### Parametry odpowiedzi

Parametr | Typ | Opis
---------- | ----- | ------
success | boolean | Czy usunięcie powiodło się

### Przykład odpowiedzi

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

---

## Push Webhook

Skonfiguruj webhook, aby otrzymywać powiadomienia push dla wiadomości

## Pobieranie konfiguracji webhook

Pobierz aktualne informacje o konfiguracji webhook.

### Żądanie

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

### Przykład żądania

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

### Parametry odpowiedzi

Parametr | Typ | Opis
---------- | ----- | ------
url | string | Adres URL webhook (może być pustym ciągiem)
enabled | boolean | Czy webhook jest włączony

### Przykład odpowiedzi

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

## Konfigurowanie webhook

Ustaw lub zaktualizuj konfigurację webhook.

### Żądanie

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

### Parametry żądania

Parametr | Typ | Wymagane | Opis
---------- | ----- | ---------- | ------
url | string | Tak | Adres URL webhook (musi być prawidłowym URL HTTP/HTTPS)
enabled | boolean | Tak | Czy webhook ma być włączony

### Przykład żądania

[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]

### Parametry odpowiedzi

Parametr | Typ | Opis
---------- | ----- | ------
success | boolean | Czy konfiguracja powiodła się

### Przykład odpowiedzi

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

## Zdarzenia webhook

Gdy nadejdzie nowa wiadomość, system wyśle żądanie POST na skonfigurowany URL.

### Format otrzymywanych danych

Nagłówki żądania:
- Content-Type: application/json
- X-Webhook-Event: new_message

### Dane push webhook

Parametr | Typ | Opis
---------- | ----- | ------
emailId | string | ID e-maila, który otrzymał wiadomość (format UUID)
messageId | string | ID nowej wiadomości (format UUID)
fromAddress | string | Adres nadawcy
subject | string | Temat wiadomości
content | string | Zawartość wiadomości jako zwykły tekst
html | string | Zawartość wiadomości jako HTML (może być pusta)
receivedAt | string | Czas odbioru wiadomości (format ISO 8601)
toAddress | string | Adres e-mail, który otrzymał wiadomość

### Przykład danych push

[Code (json)]
{
  "emailId": "c2c4f894-c672-4d5b-a918-abca95aff1f7",
  "messageId": "fd13a8df-1465-4fbc-a612-ca7311c31ff2",
  "fromAddress": "sender@example.com",
  "subject": "Wiadomość testowa",
  "content": "Zawartość wiadomości jako zwykły tekst",
  "html": "<div>Zawartość wiadomości jako HTML</div>",
  "receivedAt": "2025-01-21T08:30:45.084Z",
  "toAddress": "test@chat-tempmail.com"
}
[/Code]

### Wymagania odpowiedzi

Twój serwer powinien zwrócić kod statusu 2xx, aby wskazać pomyślne otrzymanie. Jeśli zostanie zwrócony kod statusu inny niż 2xx, system może próbować ponownie wysłać.

Zalecana odpowiedź:

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

{
  "received": true
}
[/Code]

### Ważne uwagi

- Upewnij się, że Twój URL webhook jest dostępny
- Zaleca się weryfikację integralności danych push po stronie serwera
- System wysyła push webhook natychmiast po nadejściu wiadomości
- Jeśli push nie powiedzie się, system może próbować ponownie, więc upewnij się, że Twój interfejs jest idempotentny

---