Dokumentasi pengembangAPI

API Once Email

Dokumentasi publik untuk pengujian email otomatis: autentikasi, kuota, kesalahan, dan aturan aman.

Dokumentasi tersedia untuk umum. Pembuatan kunci API dan panggilan langsung belum dibuka untuk publik. Alur berikut hanya untuk penguji yang sudah memiliki izin akses API secara eksplisit dan kredensial yang valid.
Autentikasi

Kirim Authorization: Bearer oe_live_… pada setiap permintaan. Kunci hanya ditampilkan sekali; simpan di pengelola rahasia, bukan kode browser, log, atau Git.

Authorization: Bearer oe_live_your_key
Alur untuk penguji berizin
  1. Lanjutkan hanya dengan akses API yang diizinkan secara eksplisit serta kredensial valid yang sudah diterbitkan dengan izin minimum yang diperlukan. Simpan di fasilitas rahasia proses; tanpa akses tersebut, batasi kegiatan pada meninjau dokumentasi dan unduhan. Buat kotak masuk sementara dan simpan ID-nya.
  2. Minta sistem uji mengirim email ke alamat itu.
  3. Polling daftar dengan backoff; hindari polling kosong cepat.
  4. Baca pesan target, selesaikan asersi, lalu hapus kotak masuk.

Endpoint Beta privat

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

Kode status

400

Permintaan tidak valid

401

Kunci hilang atau tidak valid

403

Paket atau sumber daya ditolak

404

Sumber daya tidak ditemukan

413

Respons atau lampiran terlalu besar

429

Batas laju atau kuota bulanan tercapai

503

Gangguan layanan sementara

Ketersediaan klien

Kandidat prarilis sumber terbuka tersedia untuk TypeScript, Python, Java, Go, .NET, PHP, dan Ruby. CI native lulus di Linux, macOS, dan Windows; rilis registry belum tersedia.

Status penagihan

Developer memakai langganan Stripe bulanan dan kuota API bulanan. Saldo isi ulang tidak ditawarkan. Checkout Live tetap ditutup sampai gerbang pembayaran dan pengembalian dana lulus.

Penggunaan yang diizinkan

Gunakan API hanya pada sistem yang boleh Anda uji. Spam, pengelakan kebijakan, penyalahgunaan akun, pemantauan komunikasi orang lain, dan penyimpanan data pribadi jangka panjang dilarang.

API sedang disiapkan untuk produksi
Dokumentasi publik dan unduhan prarilis tidak memberikan akses API. Pembuatan kunci API dan panggilan langsung belum dibuka untuk publik.
Lihat SDKLihat harga

API Demo

Contoh aman lintas platform

Untuk sistem milik sendiri atau berizin; berjalan dengan Node.js 20+ di Windows, Linux, dan macOS.

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

Panduan penggunaan lengkap

Unduh paket lokal berversi

Uji hanya aplikasi milik Anda atau yang diizinkan. Once Email hanya menerima email.

Dokumen dan sumber publik; API terkendali, SDK dan Skill kandidat di luar registry. Dokumentasi publik dan unduhan prarilis tidak memberikan akses API. Pembuatan kunci API dan panggilan langsung belum dibuka untuk publik.

Periksa SHA256SUMS sebelum ekstraksi.

Unduh paketSHA256SUMS

Titik awal lokal yang tepat

node demos/api/authorized-workflow.mjs

Dari unduhan hingga pembersihan

  1. Pastikan kepemilikan atau izin; gunakan local, test, staging.
  2. Lanjutkan hanya dengan akses API yang diizinkan secara eksplisit serta kredensial valid yang sudah diterbitkan dengan izin minimum yang diperlukan. Simpan di fasilitas rahasia proses; tanpa akses tersebut, batasi kegiatan pada meninjau dokumentasi dan unduhan.
  3. Unduh, verifikasi, ekstrak, dan baca dokumentasi.
  4. Jalankan Demo dengan Node.js 20+ dan picu email bertanda.
  5. Polling dengan tenggat dan baca hanya hasil unik.
  6. Hapus di finally; laporkan kegagalan cleanup terpisah.

Kegagalan dan pemulihan

Bedakan 400/401/403/404/413/429/503, timeout, ambigu, ekstraksi, asersi, dan cleanup. Ulangi hanya dalam satu tenggat.

Lihat sumber publikBaca panduan praktik