Documentation développeurAPI

API Once Email

Documentation publique pour les tests automatisés : authentification, quotas, erreurs et règles d’usage.

La documentation est publique. La création de clés API et les appels réels ne sont pas ouverts au public. Le parcours ci-dessous concerne uniquement les testeurs disposant déjà d’un accès API explicitement autorisé et d’identifiants valides.
Authentification

Envoyez Authorization: Bearer oe_live_… avec chaque requête. La clé n’est montrée qu’une fois ; gardez-la dans un gestionnaire de secrets, jamais dans le navigateur, les journaux ou Git.

Authorization: Bearer oe_live_your_key
Parcours pour les testeurs autorisés
  1. Continuez uniquement avec un accès API explicitement autorisé et des identifiants valides déjà délivrés, limités aux permissions nécessaires. Conservez-les dans un dispositif de secrets du processus ; sans cet accès, limitez-vous à consulter la documentation et les téléchargements. Créez une boîte temporaire et conservez son identifiant.
  2. Demandez à votre système de test d’envoyer un e-mail.
  3. Interrogez la liste avec temporisation ; évitez les requêtes vides rapides.
  4. Lisez le message, terminez les assertions puis supprimez la boîte.

Endpoints de la bêta privée

POST /v1/inboxesGET /v1/inboxes/{inboxId}/messagesGET /v1/inboxes/{inboxId}/messages/{uid}GET /v1/inboxes/{inboxId}/messages/{uid}/attachments/{cid}DELETE /v1/inboxes/{inboxId}

Codes d’état

400

Requête invalide

401

Clé absente ou invalide

403

Offre ou ressource refusée

404

Ressource introuvable

413

Réponse ou pièce jointe trop volumineuse

429

Limite ou quota mensuel atteint

503

Défaillance temporaire du service

Disponibilité des clients

Des candidats open source sont disponibles pour TypeScript, Python, Java, Go, .NET, PHP et Ruby. La CI native passe sous Linux, macOS et Windows ; les registres ne sont pas encore publiés.

État de la facturation

Developer utilise un abonnement Stripe mensuel et un quota API mensuel. Aucun solde rechargeable. Le paiement Live reste fermé jusqu’aux tests de paiement et de remboursement.

Usage autorisé

Utilisez l’API uniquement sur des systèmes que vous êtes autorisé à tester. Spam, contournement, abus de comptes, surveillance d’autrui et conservation prolongée de données personnelles sont interdits.

L’API se prépare à la production
La documentation publique et les téléchargements de préversions ne donnent aucun accès à l’API. La création de clés API et les appels réels ne sont pas ouverts au public.
Voir les SDKVoir les tarifs

API Demo

Exemple sûr multiplateforme

Pour les systèmes détenus ou autorisés avec Node.js 20+ sous Windows, Linux et macOS.

node demos/api/authorized-workflow.mjs
ONCE_EMAIL_API_KEY <- process secret facility
create inbox -> list messages -> finally delete inbox
Ouvrir la démo complète

Guide d’utilisation complet

Télécharger le paquet local versionné

Testez uniquement vos applications ou celles autorisées. Once Email reçoit uniquement les e-mails.

Documentation et code publics ; API contrôlée et préversions hors registres. La documentation publique et les téléchargements de préversions ne donnent aucun accès à l’API. La création de clés API et les appels réels ne sont pas ouverts au public.

Vérifiez SHA256SUMS avant extraction.

Télécharger le paquetSHA256SUMS

Point de départ local exact

node demos/api/authorized-workflow.mjs

Du téléchargement au nettoyage

  1. Confirmez propriété ou autorisation ; utilisez local, test ou staging.
  2. Continuez uniquement avec un accès API explicitement autorisé et des identifiants valides déjà délivrés, limités aux permissions nécessaires. Conservez-les dans un dispositif de secrets du processus ; sans cet accès, limitez-vous à consulter la documentation et les téléchargements.
  3. Téléchargez, vérifiez, extrayez et lisez la documentation.
  4. Exécutez la démo avec Node.js 20+ et déclenchez un e-mail marqué.
  5. Interrogez avec attente bornée et lisez uniquement le résultat unique.
  6. Supprimez dans finally ; signalez séparément l’échec du nettoyage.

Échecs et récupération

Distinguez 400/401/403/404/413/429/503, délai, ambiguïté, extraction, assertion et nettoyage. Réessayez uniquement avant l’échéance.

Voir le code publicLire le guide pratique