API Reference

Documentation complète de l'API JunkMail pour les développeurs

L'API est disponible exclusivement avec le plan Business.

Introduction

L'API JunkMail vous permet d'intégrer les fonctionnalités d'emails temporaires dans vos applications. Créez des adresses, récupérez des emails et configurez des webhooks programmatiquement.

Base URL

https://api.junkmail.dev/api/v1

Authentification

Toutes les requêtes API nécessitent une clé API dans le header Authorization :

Authorization: Bearer jm_live_xxxxxxxxxxxx

Format des réponses

L'API retourne des réponses JSON :

{
  "success": true,
  "data": { ... }
}

En cas d'erreur :

{
  "success": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "La clé API est invalide"
  }
}

Rate Limiting

Plan	Requêtes/minute
Business	100

Les headers de rate limit sont inclus dans chaque réponse :

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640000000

Endpoints

Endpoint	Description
Authentication	Gestion des clés API
Addresses	Créer/lister/supprimer des adresses
Emails	Récupérer/supprimer des emails
Webhooks	Configurer des webhooks
Errors	Codes d'erreur

SDK

Des SDK sont disponibles pour faciliter l'intégration :

JavaScript/TypeScript - npm install @junkmail/sdk
Python - pip install junkmail

Exemple rapide

# Créer une adresse temporaire
curl -X POST https://api.junkmail.dev/api/v1/addresses \
  -H "Authorization: Bearer jm_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{"alias": "test-api"}'

Réponse :

{
  "success": true,
  "data": {
    "id": "addr_123abc",
    "email": "test-api@junkmail.dev",
    "alias": "test-api",
    "createdAt": "2024-01-15T10:00:00Z",
    "expiresAt": "2024-01-22T10:00:00Z"
  }
}