API Penerusan Email

Daftar Isi

• Perpustakaan
• Basis URI
• Autentikasi
• Kesalahan
• Lokalisasi
• Penomoran halaman
• Akun
  • Buat Akun
  • Ambil akun
  • Perbaharui akun
• Domain
  • Daftar domain
  • Buat domain
  • Ambil domain
  • Verifikasi catatan domain
  • Perbarui domain
  • Hapus domain
• Undangan
  • Terima undangan domain
  • Buat undangan domain
  • Hapus undangan domain
• Anggota
  • Perbarui anggota domain
  • Hapus anggota domain
• Alias
  • Ambil alias domain
  • Buat alias domain baru
  • Perbarui alias domain
  • Hapus alias domain

Perpustakaan

Saat ini kami belum merilis pembungkus API, tetapi kami berencana untuk melakukannya dalam waktu dekat. Kirim email keapi@forwardemail.net jika Anda ingin diberitahu ketika bungkus API bahasa pemrograman tertentu dilepaskan. Sementara itu, Anda dapat menggunakan pustaka permintaan HTTP yang direkomendasikan ini di aplikasi Anda, atau cukup gunakanikal seperti pada contoh di bawah ini.

Bahasa	Perpustakaan
Rubi	Faraday
Python	permintaan
Jawa	OkHttp
PHP	membuang waktu
JavaScript	superagent
Node.js	superagent
Pergilah	net / http
.BERSIH	RestSharp

Basis URI

Jalur URI basis HTTP saat ini adalah:https://api.forwardemail.net. Jalur URI basis HTTP lawas darihttps://forwardemail.net:4000 akan dihentikan pada 1 Januari 2021.

Autentikasi

Semua titik akhir membutuhkankunci API gratis 🎉 to be set as the "username" value of the request's Otorisasi Dasar tajuk. Jangan khawatir - contoh disediakan di bawah ini untuk Anda jika Anda tidak yakin apa ini.

Kesalahan

Jika ada kesalahan, badan respons permintaan API akan berisi pesan kesalahan terperinci. Selain memiliki lebih dari sepuluh tahun pengalaman menulis API dan mendokumentasikannya, terinspirasi olehStripe beautiful API documentation when we crafted ours 😄.

Kode	Nama
200	baik
400	Permintaan yang buruk
401	Tidak resmi
403	Terlarang
404	Tidak ditemukan
429	Terlalu Banyak Permintaan
500	Kesalahan server dari dalam
501	Tidak Diimplementasikan
502	Gerbang Buruk
503	Layanan tidak tersedia
504	Gerbang Waktu habis

Lokalisasi

Layanan kami diterjemahkan ke lebih dari 25 bahasa yang berbeda. Semua pesan respons API diterjemahkan ke lokal terakhir yang terdeteksi dari pengguna yang membuat permintaan API. Anda dapat mengesampingkan ini dengan melewati kebiasaanAccept-Language tajuk. Jangan ragu untuk mencobanya menggunakan drop-down bahasa di bagian bawah halaman ini.

Penomoran halaman

Jika Anda ingin diberi tahu saat pagination tersedia, silakan kirim emailapi@forwardemail.net.

Akun

Buat Akun

POST /v1/account

Parameter tubuh	Yg dibutuhkan	Tipe	Deskripsi
email	Iya	String (Email)	Alamat email
password	Iya	Tali	Kata sandi

Contoh Permintaan:

curl -X POST https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Ambil akun

GET /v1/account

Contoh Permintaan:

curl -X GET https://api.forwardemail.net/v1/account \
  -u API_TOKEN:

Perbaharui akun

PUT /v1/account

Parameter tubuh	Yg dibutuhkan	Tipe	Deskripsi
email	Tidak	String (Email)	Alamat email
given_name	Tidak	Tali	Nama depan
family_name	Tidak	Tali	nama keluarga
avatar_url	Tidak	String (URL)	Tautan ke gambar avatar

Contoh Permintaan:

curl -X PUT https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Domain

Daftar domain

GET /v1/domains

Parameter Pertanyaan	Yg dibutuhkan	Tipe	Deskripsi
name	Tidak	String (didukung oleh RegExp)	Cari domain berdasarkan nama
alias	Tidak	String (didukung oleh RegExp)	Cari domain dengan nama alias
recipient	Tidak	String (didukung oleh RegExp)	Cari domain berdasarkan penerima

Contoh Permintaan:

curl -X GET https://api.forwardemail.net/v1/domains \
  -u API_TOKEN:

Buat domain

POST /v1/domains

Parameter tubuh	Yg dibutuhkan	Tipe	Deskripsi
domain	Iya	String (FQDN atau IP)	Nama domain yang sepenuhnya memenuhi syarat ("FQDN") atau alamat IP
plan	Tidak	String (dapat dihitung)	Jenis paket (harus"free","enhanced_protection", atau"team", default ke"free")
catchall	Tidak	String (alamat email yang dibatasi) atau Boolean	Buat alias penampung-semua default, dengan defaulttrue (jikatrue itu akan menggunakan alamat email pengguna API sebagai penerima, dan jikafalse tidak ada tangkapan semua yang akan dibuat). Jika String diteruskan, maka itu adalah daftar alamat email yang dipisahkan untuk digunakan sebagai penerima (dipisahkan oleh jeda baris, spasi, dan / atau koma)

Contoh Permintaan:

curl -X POST https://api.forwardemail.net/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

Ambil domain

GET /v1/domains/example.com

Contoh Permintaan:

curl -X GET https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Verifikasi catatan domain

GET /v1/domains/example.com/verify-records

Contoh Permintaan:

curl -X GET https://api.forwardemail.net/v1/domains/example.com/verify-records \
  -u API_TOKEN:

Perbarui domain

PUT /v1/domains/example.com

Parameter tubuh	Yg dibutuhkan	Tipe	Deskripsi
smtp_port	Tidak	String atau Angka	Port khusus untuk dikonfigurasikan untuk penerusan SMTP (standarnya adalah"25")

Contoh Permintaan:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Hapus domain

DELETE /v1/domains/:domain_name

Contoh Permintaan:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
  -u API_TOKEN:

Undangan

Terima undangan domain

GET /v1/domains/:domain_name/invites

Contoh Permintaan:

curl -X GET https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Buat undangan domain

POST /v1/domains/example.com/invites

Parameter tubuh	Yg dibutuhkan	Tipe	Deskripsi
email	Iya	String (Email)	Alamat email untuk diundang ke daftar anggota domain
group	Iya	String (dapat dihitung)	Grup untuk menambahkan pengguna ke keanggotaan domain dengan (dapat menjadi salah satu dari"admin" atau"user")

Contoh Permintaan:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/invites \
  -u API_TOKEN: \
  -d "email=user%40gmail.com" \
  -d group=admin

Hapus undangan domain

DELETE /v1/domains/:domain_name/invites

Parameter tubuh	Yg dibutuhkan	Tipe	Deskripsi
email	Iya	String (Email)	Alamat email untuk dihapus dari daftar anggota domain

Contoh Permintaan:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Anggota

Perbarui anggota domain

PUT /v1/domains/example.com/members/:member_id

Parameter tubuh	Yg dibutuhkan	Tipe	Deskripsi
group	Iya	String (dapat dihitung)	Grup untuk memperbarui pengguna ke keanggotaan domain dengan (dapat menjadi salah satu dari"admin" atau"user")

Contoh Permintaan:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

Hapus anggota domain

DELETE /v1/domains/:domain_name/members/:member_id

Contoh Permintaan:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/members/:member_id \
  -u API_TOKEN:

Alias

Ambil alias domain

GET /v1/domains/example.com/aliases

Contoh Permintaan:

curl -X GET https://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

Buat alias domain baru

POST /v1/domains/example.com/aliases

Parameter tubuh	Yg dibutuhkan	Tipe	Deskripsi
name	Iya	Tali	Nama alias
recipients	Iya	String atau Array	Daftar penerima (harus String-break / spasi / dipisahkan koma atau Array alamat email yang valid, nama domain yang memenuhi syarat ("FQDN"), alamat IP, dan / atau URL webhook URL)
description	Tidak	Tali	Deskripsi alias
labels	Tidak	String atau Array	Daftar label (harus dipisahkan dengan garis / spasi / String atau Array yang dipisahkan koma)
is_enabled	Tidak	Boolean	Apakah akan mengaktifkan untuk menonaktifkan alias ini (jika dinonaktifkan, email akan dialihkan ke mana pun tetapi mengembalikan kode status yang berhasil)

Contoh Permintaan:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

Perbarui alias domain

PUT /v1/domains/example.com/aliases/:alias_id

Parameter tubuh	Yg dibutuhkan	Tipe	Deskripsi
name	Tidak	Tali	Nama alias
recipients	Iya	String atau Array	Daftar penerima (harus String-break / spasi / dipisahkan koma atau Array alamat email yang valid, nama domain yang memenuhi syarat ("FQDN"), alamat IP, dan / atau URL webhook URL)
description	Tidak	Tali	Deskripsi alias
labels	Tidak	String atau Array	Daftar label (harus dipisahkan dengan garis / spasi / String atau Array yang dipisahkan koma)
is_enabled	Tidak	Boolean	Apakah akan mengaktifkan untuk menonaktifkan alias ini (jika dinonaktifkan, email akan dialihkan ke mana pun tetapi mengembalikan kode status yang berhasil)

Contoh Permintaan:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id \
  -u API_TOKEN:

Hapus alias domain

DELETE /v1/domains/:domain_name/aliases/:alias_id

Contoh Permintaan:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN: