Dokumentacja API

Wepnij jednorazowe adresy e-mail w swoje aplikacje i procesy

https://dustmail.net/api/v1

🔑 Uwierzytelnianie

Wszystkie zapytania do API wymagają klucza API. Przekaż swój klucz w nagłówku Authorization albo w nagłówku X-API-Key .

Klucze API wygenerujesz w swoim Panelu. Każdy klucz zaczyna się od dm_live_.

bash

# Using Authorization header (recommended)
curl https://dustmail.net/api/v1/inbox \
  -H "Authorization: Bearer dm_live_your_api_key"

# Using X-API-Key header
curl https://dustmail.net/api/v1/inbox \
  -H "X-API-Key: dm_live_your_api_key"

Limity zapytań

Darmowy

100

zapytań / dzień

Premium

∞

bez limitu

POST/api/v1/inbox

Tworzy nową tymczasową skrzynkę e-mail. Zwraca szczegóły skrzynki wraz z wygenerowanym adresem e-mail i czasem wygaśnięcia. Klucze Premium mogą dodatkowo poprosić o własną nazwę użytkownika, wybrać jedną ze skonfigurowanych domen współdzielonych albo wskazać zweryfikowane domeny własne należące do użytkownika Premium po weryfikacji DNS TXT + MX.

Treść zapytania

Parametr	Typ	Opis
usernameopcjonalny	string	Własna nazwa użytkownika dla adresu e-mail. Wymaga klucza API Premium.
domainopcjonalny	string	Żądana domena skrzynki. Klucze darmowe używają głównej domeny współdzielonej, a klucze Premium mogą wybrać skonfigurowane domeny współdzielone lub zweryfikowane domeny własne właściciela klucza API.

Przykład

bash

curl -X POST https://dustmail.net/api/v1/inbox \
  -H "Authorization: Bearer dm_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"username":"swift.fox4291","domain":"brand.example"}'

Odpowiedź

json

{
  "success": true,
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "email": "[email protected]",
    "domain": "brand.example",
    "created_at": "2026-03-30T12:00:00.000Z",
    "expires_at": "2027-03-30T12:00:00.000Z"
  },
  "meta": {
    "plan": "premium",
    "rate_limit": { "limit": null, "used": 1 },
    "available_domains": ["dustmail.net", "<configured-shared-domain>", "brand.example"]
  }
}

GET/api/v1/inbox

Wypisuje wszystkie aktywne skrzynki powiązane z Twoim kontem. Zwraca do 50 skrzynek wraz z liczbą wiadomości.

Przykład

bash

curl https://dustmail.net/api/v1/inbox \
  -H "Authorization: Bearer dm_live_your_api_key"

Odpowiedź

json

{
  "success": true,
  "data": [
    {
      "id": "a1b2c3d4-...",
      "email": "[email protected]",
      "domain": "dustmail.net",
      "created_at": "2026-03-30T12:00:00.000Z",
      "expires_at": "2026-03-30T12:30:00.000Z",
      "email_count": 3
    }
  ],
  "meta": {
    "total": 1,
    "plan": "free",
    "rate_limit": { "limit": 100, "used": 2 }
  }
}

GET/api/v1/inbox/:id

Pobiera szczegóły skrzynki i wszystkie odebrane wiadomości. Zwraca do 100 najnowszych wiadomości z pełną treścią (tekst i HTML).

Parametry ścieżki

Parametr	Typ	Opis
idwymagany	uuid	Identyfikator skrzynki zwrócony przy tworzeniu

Przykład

bash

curl https://dustmail.net/api/v1/inbox/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer dm_live_your_api_key"

Odpowiedź

json

{
  "success": true,
  "data": {
    "inbox": {
      "id": "a1b2c3d4-...",
      "email": "[email protected]",
      "domain": "dustmail.net",
      "created_at": "2026-03-30T12:00:00.000Z",
      "expires_at": "2026-03-30T12:30:00.000Z"
    },
    "emails": [
      {
        "id": "e1f2a3b4-...",
        "from": "[email protected]",
        "subject": "Verify your email address",
        "text": "Click the link below to verify...",
        "html": "<html>...</html>",
        "received_at": "2026-03-30T12:05:30.000Z"
      }
    ]
  },
  "meta": {
    "email_count": 1,
    "rate_limit": { "limit": 100, "used": 3 }
  }
}

Przykłady kodu

javascript

// Node.js / JavaScript
const response = await fetch(
  'https://dustmail.net/api/v1/inbox/YOUR_INBOX_ID',
  { headers: { 'Authorization': 'Bearer dm_live_your_api_key' } }
);
const { data } = await response.json();
console.log(data.emails); // Array of received emails

python

# Python
import requests

resp = requests.get(
    "https://dustmail.net/api/v1/inbox/YOUR_INBOX_ID",
    headers={"Authorization": "Bearer dm_live_your_api_key"}
)
emails = resp.json()["data"]["emails"]
print(f"Received {len(emails)} emails")

DELETE/api/v1/inbox/:id

Usuwa (dezaktywuje) skrzynkę. Możesz usuwać wyłącznie skrzynki należące do Twojego konta. Po usunięciu API przestanie ją zwracać.

Przykład

bash

curl -X DELETE https://dustmail.net/api/v1/inbox/a1b2c3d4-... \
  -H "Authorization: Bearer dm_live_your_api_key"

Odpowiedź

json

{
  "success": true,
  "message": "Inbox deleted"
}