Once Email API-Dokumentation

Die Dokumentation ist öffentlich. Das Erstellen von API-Schlüsseln und echte Aufrufe sind noch nicht öffentlich freigegeben. Der folgende Ablauf gilt nur für Tester mit bereits ausdrücklich autorisiertem API-Zugriff und gültigen Zugangsdaten.

Authentifizierung

Sende bei jeder Anfrage Authorization: Bearer oe_live_…. Ein Schlüssel wird einmal angezeigt; speichere ihn im Secret Manager, nie in Browsercode, Logs oder Git.

Authorization: Bearer oe_live_your_key

Ablauf für autorisierte Tester

Fahre nur mit ausdrücklich autorisiertem API-Zugriff und bereits ausgestellten, gültigen Zugangsdaten mit den notwendigen Minimalrechten fort. Bewahre sie in einer Secret-Verwaltung des Prozesses auf. Ohne diesen Zugriff beschränke dich auf Dokumentation und Downloads. Erstelle ein temporäres Postfach und behalte seine ID.
Lass dein Testsystem eine E-Mail dorthin senden.
Frage die Nachrichtenliste mit Backoff ab; vermeide schnelle Leerabfragen.
Lies die Zielnachricht, prüfe das Ergebnis und lösche das Postfach.

Private-Beta-Endpunkte

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

Statuscodes

400

Ungültige Anfrage

401

Schlüssel fehlt oder ist ungültig

403

Tarif oder Ressource verweigert

404

Ressource nicht gefunden

413

Antwort oder Anhang zu groß

429

Rate- oder Monatslimit erreicht

503

Vorübergehender Dienstfehler

Client-Verfügbarkeit

Open-Source-Vorabkandidaten sind für TypeScript, Python, Java, Go, .NET, PHP und Ruby verfügbar. Native CI bestand unter Linux, macOS und Windows; Registry-Releases fehlen noch.

Abrechnungsstatus

Developer nutzt ein monatliches Stripe-Abo mit monatlichem API-Kontingent. Aufladbares Guthaben wird nicht angeboten. Live-Checkout bleibt bis zu Zahlungs- und Erstattungstests geschlossen.

Zulässige Nutzung

Nutze die API nur für Systeme, die du testen darfst. Spam, Regelumgehung, Kontomissbrauch, Überwachung fremder Kommunikation und langfristige Speicherung personenbezogener Daten sind verboten.

Die API wird produktionsbereit gemacht

Öffentliche Dokumentation und Vorabdownloads erteilen keinen API-Zugriff. Das Erstellen von API-Schlüsseln und echte Aufrufe sind nicht öffentlich freigegeben.

SDKs ansehen Preise ansehen

API Demo

Sicheres plattformübergreifendes Beispiel

Für eigene oder autorisierte Testsysteme mit Node.js 20+ unter Windows, Linux und macOS.

node demos/api/authorized-workflow.mjs
ONCE_EMAIL_API_KEY <- process secret facility
create inbox -> list messages -> finally delete inbox

Vollständige Demo öffnen

Vollständige Anleitung

Versioniertes lokales Paket laden

Nur eigene oder ausdrücklich autorisierte Anwendungen testen. Once Email empfängt E-Mails nur.

Dokumentation und Code öffentlich; API kontrolliert, Vorabdownloads außerhalb der Registries. Öffentliche Dokumentation und Vorabdownloads erteilen keinen API-Zugriff. Das Erstellen von API-Schlüsseln und echte Aufrufe sind nicht öffentlich freigegeben.

SHA256SUMS vor dem Entpacken prüfen.

Paket laden SHA256SUMS

Exakter lokaler Startpunkt

node demos/api/authorized-workflow.mjs

Vom Download zur Bereinigung

Eigentum oder Autorisierung prüfen; nur local, test oder staging.
Fahre nur mit ausdrücklich autorisiertem API-Zugriff und bereits ausgestellten, gültigen Zugangsdaten mit den notwendigen Minimalrechten fort. Bewahre sie in einer Secret-Verwaltung des Prozesses auf. Ohne diesen Zugriff beschränke dich auf Dokumentation und Downloads.
Laden, prüfen, entpacken und Dokumentation lesen.
Demo mit Node.js 20+ ausführen und markierte Mail auslösen.
Begrenzt abfragen und nur eindeutigen Treffer lesen.
In finally löschen; Bereinigungsfehler separat melden.

Fehler und Wiederherstellung

400/401/403/404/413/429/503, Timeout, Mehrdeutigkeit, Extraktion, Assertion und Bereinigung getrennt behandeln. Nur innerhalb einer Frist wiederholen.

Öffentlichen Code ansehen Praxisleitfaden lesen