Dokumentácia API

Integrujte jednorazové e-mailové adresy do svojich aplikácií a pracovných postupov

https://dustmail.net/api/v1

🔑 Autentifikácia

Všetky požiadavky API vyžadujú API kľúč. Kľúč odovzdajte cez hlavičku Authorization alebo hlavičku X-API-Key .

API kľúče vytvoríte na nástenke. Každý kľúč začína na 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 požiadaviek

Bezplatný
100
požiadaviek / deň
Premium
neobmedzené
POST/api/v1/inbox

Vytvorte novú dočasnú e-mailovú schránku. Vráti podrobnosti schránky vrátane vygenerovanej e-mailovej adresy a času vypršania. Kľúče Premium môžu tiež požadovať vlastné používateľské meno, vybrať si z nakonfigurovaných zdieľaných domén alebo zvoliť overené vlastné domény patriace používateľovi Premium po overení DNS TXT + MX.

Telo požiadavky

ParameterTypPopis
usernamevoliteľnýstringVlastné používateľské meno pre e-mailovú adresu. Vyžaduje kľúč Premium API.
domainvoliteľnýstringPožadovaná doména schránky. Bezplatné kľúče používajú primárnu zdieľanú doménu, zatiaľ čo kľúče Premium si môžu vybrať nakonfigurované zdieľané domény alebo overené vlastné domény vlastníka API kľúča.

Príklad

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"}'

Odpoveď

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

Vypíše všetky aktívne schránky priradené k vášmu účtu. Vráti až 50 schránok s počtom e-mailov.

Príklad

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

Odpoveď

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

Získa podrobnosti schránky a všetky prijaté e-maily. Vráti až 100 najnovších e-mailov s úplným obsahom (text a HTML).

Parametre cesty

ParameterTypPopis
idpovinnýuuidID schránky vrátené pri vytvorení

Príklad

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

Odpoveď

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 }
  }
}

Príklady kódu

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

Vymaže (deaktivuje) schránku. Môžete vymazať iba schránky, ktoré vlastní váš účet. Po vymazaní ich API už nebude vracať.

Príklad

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

Odpoveď

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