Gerçek veri ve anahtarlara sahip dokümanlara mı ihtiyacınız var?

API anahtarlarınızın ve gerçek hesap verilerinizin aşağıda doldurulması için kayıt olun veya giriş yapın.

Gizlilik Politikamızı ve Koşullarımızı kabul ediyorsunuz.

İlgilenmiyorum? Okumaya devam etmek için burayı tıklayın

İçindekiler

Alan adlarına, takma adlara ve daha fazlasına programlı erişim için bir API oluşturduk.

API Belgeleri

Verilerinize programlı erişim

E-posta Yönlendirme API'sı

İçindekiler

Kütüphaneler

Şu anda henüz herhangi bir API sarmalayıcı yayınlamadık, ancak bunu yakın gelecekte yapmayı planlıyoruz. e-posta gönder api@forwardemail.net belirli bir programlama dilinin API sarmalayıcısı yayınlandığında bilgilendirilmek istiyorsanız. Bu arada, uygulamanızda bu önerilen HTTP istek kitaplıklarını kullanabilir veya sadece bukle aşağıdaki örneklerde olduğu gibi.

DilKütüphane
YakutFaraday
pitonistekler
JavaOkHttp
PHPtıkınmak
JavaScriptsüper ajan
node.jssüper ajan
Gitnet / http
.NETDinlenmeKeskin

Temel URI

Geçerli HTTP temel URI yolu: https://api.forwardemail.net. Eski HTTP temel URI yolu https://forwardemail.net:4000 1 Ocak 2021'den itibaren kullanımdan kaldırılmıştır.

Kimlik Doğrulama

Tüm uç noktalar için API anahtarı isteğin "kullanıcı adı" değeri olarak ayarlanacak Temel Yetkilendirme başlık. Endişelenmeyin – bunun ne olduğundan emin değilseniz aşağıda örnekler verilmiştir.

Hatalar

Herhangi bir hata meydana gelirse, API isteğinin yanıt gövdesi ayrıntılı bir hata mesajı içerir.

kodad
200OK
400Geçersiz istek
401Yetkisiz
403yasak
404Bulunamadı
429Çok fazla istek
500İç Sunucu Hatası
501Uygulanmadı
502Bozuk Ağ Geçidi
503hizmet kullanılamıyor
504Ağ Geçidi Zaman Aşımı
İpucu: Bir 5xx durum kodu alırsanız (ki bu olmamalıdır), o zaman lütfen şu adresten bizimle iletişime geçin: api@forwardemail.net ve sorununuzu hemen çözmenize yardımcı olacağız.

yerelleştirme

Hizmetimiz 25'in üzerinde farklı dile çevrilmiştir. Tüm API yanıt mesajları, API isteğinde bulunan kullanıcının tespit edilen son yerel ayarına çevrilir. Bir özel ileterek bunu geçersiz kılabilirsiniz Accept-Language başlık. Bu sayfanın altındaki dil açılır menüsünü kullanarak bunu denemekten çekinmeyin.

sayfalara numara koyma

Sayfalandırma kullanılabilir olduğunda bilgilendirilmek istiyorsanız, lütfen e-posta gönderin api@forwardemail.net.

hesap

Hesap oluştur

POST /v1/account

Gövde ParametresigereklidirtipAçıklama
emailEvetDize (E-posta)E
passwordEvetsicimParola

Örnek İstek:

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

Hesabı kurtar

GET /v1/account

Örnek İstek:

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

Hesabı güncelle

PUT /v1/account

Gövde ParametresigereklidirtipAçıklama
emailHayırDize (E-posta)E
given_nameHayırsicimİsim
family_nameHayırsicimSoyadı
avatar_urlHayırDize (URL)Avatar resmine bağlantı

Örnek İstek:

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

Alanlar

İpucu: Bir etki alanı adına sahip etki alanı uç noktaları /v1/domains/:domain_name yolları bir alanın kimliğiyle değiştirilebilir olduğundan :domain_id. Bu, etki alanına şu şekilde başvurabileceğiniz anlamına gelir: name veya id değer.

Alan adlarını listele

GET /v1/domains

Sorgu Dizesi ParametresigereklidirtipAçıklama
nameHayırDize (RegExp desteklenir)Alan adlarını ada göre arayın
aliasHayırDize (RegExp desteklenir)Alan adını takma ada göre arayın
recipientHayırDize (RegExp desteklenir)Alan adlarını alıcıya göre arayın

Örnek İstek:

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

Alan adı oluştur

POST /v1/domains

Gövde ParametresigereklidirtipAçıklama
domainEvetDize (FQDN veya IP)Tam nitelikli alan adı ("FQDN") veya IP adresi
planHayırDize (numaralandırılabilir)Plan türü (olmalıdır "free", "enhanced_protection", veya "team", varsayılan olarak "free" veya kullanıcının mevcut ücretli planı varsa)
catchallHayırDize (ayrılmış e-posta adresleri) veya BooleVarsayılan bir tümünü yakalama takma adı oluşturun, varsayılan olarak true (eğer true API kullanıcısının e-posta adresini alıcı olarak kullanacak ve eğer false tümünü yakalama oluşturulmaz). Bir Dize iletilirse, alıcı olarak kullanılacak e-posta adreslerinin sınırlandırılmış bir listesidir (satır sonu, boşluk ve/veya virgülle ayrılmış)
has_adult_content_protectionHayırBooleBu etki alanında Spam Tarayıcı yetişkinlere uygun içerik korumasının etkinleştirilip etkinleştirilmeyeceğini
has_phishing_protectionHayırBooleBu etki alanında Spam Tarayıcı kimlik avı korumasının etkinleştirilip etkinleştirilmeyeceğini
has_executable_protectionHayırBooleBu etki alanında Spam Tarayıcı yürütülebilir korumasının etkinleştirilip etkinleştirilmeyeceğini
has_virus_protectionHayırBooleBu etki alanında Spam Tarayıcı virüs korumasının etkinleştirilip etkinleştirilmeyeceğini
has_recipient_verificationHayırBooleTakma ad alıcılarının e-postaların akması için bir e-posta doğrulama bağlantısını tıklamasını gerektirip gerektirmeyeceğine ilişkin genel etki alanı varsayılanı

Örnek İstek:

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

Alan adını al

GET /v1/domains/example.com

Örnek İstek:

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

Alan adı kayıtlarını doğrulayın

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

Örnek İstek:

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

Alan adını güncelleyin

PUT /v1/domains/example.com

Gövde ParametresigereklidirtipAçıklama
smtp_portHayırDize veya SayıSMTP iletmek için yapılandırılacak özel bağlantı noktası (varsayılan "25")
has_adult_content_protectionHayırBooleBu etki alanında Spam Tarayıcı yetişkinlere uygun içerik korumasının etkinleştirilip etkinleştirilmeyeceğini
has_phishing_protectionHayırBooleBu etki alanında Spam Tarayıcı kimlik avı korumasının etkinleştirilip etkinleştirilmeyeceğini
has_executable_protectionHayırBooleBu etki alanında Spam Tarayıcı yürütülebilir korumasının etkinleştirilip etkinleştirilmeyeceğini
has_virus_protectionHayırBooleBu etki alanında Spam Tarayıcı virüs korumasının etkinleştirilip etkinleştirilmeyeceğini
has_recipient_verificationHayırBooleTakma ad alıcılarının e-postaların akması için bir e-posta doğrulama bağlantısını tıklamasını gerektirip gerektirmeyeceğine ilişkin genel etki alanı varsayılanı

Örnek İstek:

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

Alan adını sil

DELETE /v1/domains/:domain_name

Örnek İstek:

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

Davet etmek

Alan adı davetini kabul et

GET /v1/domains/:domain_name/invites

Örnek İstek:

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

Alan adı daveti oluştur

POST /v1/domains/example.com/invites

Gövde ParametresigereklidirtipAçıklama
emailEvetDize (E-posta)Alan adı üye listesine davet edilecek e-posta adresi
groupEvetDize (numaralandırılabilir)Kullanıcının etki alanı üyeliğine ekleneceği grup (şunlardan biri olabilir: "admin" veya "user")

Örnek İstek:

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

Alan adı davetini kaldır

DELETE /v1/domains/:domain_name/invites

Gövde ParametresigereklidirtipAçıklama
emailEvetDize (E-posta)Alan adı üyeleri listesinden kaldırılacak e-posta adresi

Örnek İstek:

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

Üyeler

Alan adını güncelleyin

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

Gövde ParametresigereklidirtipAçıklama
groupEvetDize (numaralandırılabilir)Kullanıcıyı etki alanı üyeliğine güncellemek için grup (biri olabilir "admin" veya "user")

Örnek İstek:

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

Etki alanı üyesini kaldır

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

Örnek İstek:

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

Takma adlar

Alan takma adlarını listeleyin

GET /v1/domains/example.com/aliases

Sorgu Dizesi ParametresigereklidirtipAçıklama
nameHayırDize (RegExp desteklenir)Ada göre bir etki alanında takma ad arayın
recipientHayırDize (RegExp desteklenir)Alıcıya göre bir alanda takma ad arayın

Örnek İstek:

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

Yeni alan takma adı oluştur

POST /v1/domains/example.com/aliases

Gövde ParametresigereklidirtipAçıklama
nameEvetsicimTakma ad
recipientsEvetDize veya DiziAlıcıların listesi (satır sonu / boşluk / virgülle ayrılmış Geçerli e-posta adreslerinin Dizesi veya Dizisi, tam nitelikli alan adları ("FQDN"), IP adresleri ve / veya web kanca URL'leri olmalıdır)
descriptionHayırsicimTakma ad açıklaması
labelsHayırDize veya DiziEtiketlerin listesi (satır sonu / boşluk / virgülle ayrılmış Dize veya Dizi olmalıdır)
has_recipient_verificationHayırBooleAlıcıların e-postaların akması için bir e-posta doğrulama bağlantısını tıklamasını zorunlu kılıp kılmama durumu (istek gövdesinde açıkça ayarlanmadıysa, varsayılan olarak alan ayarıdır)
is_enabledHayırBooleBu takma adı devre dışı bırakmanın etkinleştirilip etkinleştirilmeyeceği (devre dışı bırakılmışsa, e-postalar hiçbir yere yönlendirilmez, ancak başarılı durum kodları döndürülür)

Örnek İstek:

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

Alan takma adını al

Bir alan takma adını aşağıdakilerden biri ile alabilirsiniz: id veya onun name değer.

GET /v1/domains/:domain_name/aliases/:alias_id

Örnek İstek:

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

GET /v1/domains/:domain_name/aliases/:alias_name

Örnek İstek:

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

Alan takma adını güncelleme

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

Gövde ParametresigereklidirtipAçıklama
nameHayırsicimTakma ad
recipientsEvetDize veya DiziAlıcıların listesi (satır sonu / boşluk / virgülle ayrılmış Geçerli e-posta adreslerinin Dizesi veya Dizisi, tam nitelikli alan adları ("FQDN"), IP adresleri ve / veya web kanca URL'leri olmalıdır)
descriptionHayırsicimTakma ad açıklaması
labelsHayırDize veya DiziEtiketlerin listesi (satır sonu / boşluk / virgülle ayrılmış Dize veya Dizi olmalıdır)
has_recipient_verificationHayırBooleAlıcıların e-postaların akması için bir e-posta doğrulama bağlantısını tıklamasını zorunlu kılıp kılmama durumu (istek gövdesinde açıkça ayarlanmadıysa, varsayılan olarak alan ayarıdır)
is_enabledHayırBooleBu takma adı devre dışı bırakmanın etkinleştirilip etkinleştirilmeyeceği (devre dışı bırakılmışsa, e-postalar hiçbir yere yönlendirilmez, ancak başarılı durum kodları döndürülür)

Örnek İstek:

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

Alan takma adını sil

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

Örnek İstek:

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