Construire avec Run2Mail

Developer API Documentation

Learn how to create API keys, authenticate requests, create inboxes, fetch messages, and handle common Run2Mail API responses.

Clés API Authentification Points de terminaison principaux Codes d'erreur

Clés API

Générez des clés API de développeur depuis votre tableau de bord. Chaque clé est affichée dans son intégralité une seule fois, puis stockée sous forme de hachage sécurisé pour une vérification ultérieure.

Créez des clés à partir de votre tableau de bord connecté.
Gardez les clés privées et stockez-les dans votre propre gestionnaire de secrets.
Révoquez les anciennes clés chaque fois qu'un appareil, un script ou un coéquipier n'a plus besoin d'y accéder.

Authentification

Utilisez un jeton Bearer dans l’en-tête Authorization pour chaque demande protégée.

Authorization: Bearer YOUR_API_KEY

Si la clé est invalide, révoquée ou manquante, l'API répond avec une erreur d'authentification.

Points de terminaison principaux

Le flux de travail le plus courant est le suivant : inspecter l'utilisateur authentifié, créer une boîte de réception, puis récupérer les messages de cette boîte de réception.

Vérifier le compte courant

curl -X GET "https://run2mail.com/api/v1/me" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Créer une boîte de réception

curl -X POST "https://run2mail.com/api/v1/emails/create" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "random"
  }'

Récupérer les messages de la boîte de réception

curl -X GET "https://run2mail.com/api/v1/emails/example@2mail.lol/messages" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Exemple de réponse JSON

{
  "success": true,
  "data": {
    "email": "example@2mail.lol",
    "messages": []
  }
}

Limitation du débit

Run2Mail applique des limites de requêtes basées sur le plan et des limites de création quotidienne de boîtes de réception pour protéger le service et maintenir l'accès à l'API stable.

Les limites de tarif par minute dépendent de votre forfait actif.
Les limites de création d’e-mails sont suivies séparément des appels de lecture de base.
L'utilisation est enregistrée pour plus de visibilité dans le tableau de bord d'analyse d'administration.

Codes d'erreur

401: Informations d'identification API manquantes ou invalides.
403: Accès bloqué, restreint ou non autorisé pour la demande.
429: Le volume des demandes a dépassé la limite actuelle.
503: API développeur temporairement désactivée par la plateforme.

Des captures d'écran de l'API du tableau de bord seront bientôt disponibles

Cette zone est réservée aux futures captures d'écran du gestionnaire de clés API et du tableau de bord d'utilisation.

API Developpeur