E-posta Yönlendirme API'sı

İçindekiler

• Kütüphaneler
• Temel URI
• Kimlik Doğrulama
• Hatalar
• yerelleştirme
• sayfalara numara koyma
• hesap
  • Hesap oluştur
  • Hesabı kurtar
  • Hesabı güncelle
• Alanlar
  • Alan adlarını listele
  • Alan adı oluştur
  • Alan adını al
  • Alan adı kayıtlarını doğrulayın
  • Alan adını güncelleyin
  • Alan adını sil
• Davet etmek
  • Alan adı davetini kabul et
  • Alan adı daveti oluştur
  • Alan adı davetini kaldır
• Üyeler
  • Alan adını güncelleyin
  • Etki alanı üyesini kaldır
• Takma adlar
  • Alan takma adlarını listeleyin
  • Yeni alan takma adı oluştur
  • Alan takma adını al
  • Alan takma adını güncelleme
  • Alan takma adını sil

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.

Dil	Kütüphane
Yakut	Faraday
piton	istekler
Java	OkHttp
PHP	tıkınmak
JavaScript	süper ajan
node.js	süper ajan
Git	net / http
.NET	DinlenmeKeskin

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.

kod	ad
200	OK
400	Geçersiz istek
401	Yetkisiz
403	yasak
404	Bulunamadı
429	Çok fazla istek
500	İç Sunucu Hatası
501	Uygulanmadı
502	Bozuk Ağ Geçidi
503	hizmet kullanılamıyor
504	Ağ Geçidi Zaman Aşımı

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 Parametresi	gereklidir	tip	Açıklama
email	Evet	Dize (E-posta)	E
password	Evet	sicim	Parola

Ö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 Parametresi	gereklidir	tip	Açıklama
email	Hayır	Dize (E-posta)	E
given_name	Hayır	sicim	İsim
family_name	Hayır	sicim	Soyadı
avatar_url	Hayır	Dize (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

Alan adlarını listele

GET /v1/domains

Sorgu Dizesi Parametresi	gereklidir	tip	Açıklama
name	Hayır	Dize (RegExp desteklenir)	Alan adlarını ada göre arayın
alias	Hayır	Dize (RegExp desteklenir)	Alan adını takma ada göre arayın
recipient	Hayır	Dize (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 Parametresi	gereklidir	tip	Açıklama
domain	Evet	Dize (FQDN veya IP)	Tam nitelikli alan adı ("FQDN") veya IP adresi
plan	Hayır	Dize (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)
catchall	Hayır	Dize (ayrılmış e-posta adresleri) veya Boole	Varsayı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_protection	Hayır	Boole	Bu etki alanında Spam Tarayıcı yetişkinlere uygun içerik korumasının etkinleştirilip etkinleştirilmeyeceğini
has_phishing_protection	Hayır	Boole	Bu etki alanında Spam Tarayıcı kimlik avı korumasının etkinleştirilip etkinleştirilmeyeceğini
has_executable_protection	Hayır	Boole	Bu etki alanında Spam Tarayıcı yürütülebilir korumasının etkinleştirilip etkinleştirilmeyeceğini
has_virus_protection	Hayır	Boole	Bu etki alanında Spam Tarayıcı virüs korumasının etkinleştirilip etkinleştirilmeyeceğini
has_recipient_verification	Hayır	Boole	Takma 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 Parametresi	gereklidir	tip	Açıklama
smtp_port	Hayır	Dize veya Sayı	SMTP iletmek için yapılandırılacak özel bağlantı noktası (varsayılan "25")
has_adult_content_protection	Hayır	Boole	Bu etki alanında Spam Tarayıcı yetişkinlere uygun içerik korumasının etkinleştirilip etkinleştirilmeyeceğini
has_phishing_protection	Hayır	Boole	Bu etki alanında Spam Tarayıcı kimlik avı korumasının etkinleştirilip etkinleştirilmeyeceğini
has_executable_protection	Hayır	Boole	Bu etki alanında Spam Tarayıcı yürütülebilir korumasının etkinleştirilip etkinleştirilmeyeceğini
has_virus_protection	Hayır	Boole	Bu etki alanında Spam Tarayıcı virüs korumasının etkinleştirilip etkinleştirilmeyeceğini
has_recipient_verification	Hayır	Boole	Takma 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 Parametresi	gereklidir	tip	Açıklama
email	Evet	Dize (E-posta)	Alan adı üye listesine davet edilecek e-posta adresi
group	Evet	Dize (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 Parametresi	gereklidir	tip	Açıklama
email	Evet	Dize (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 Parametresi	gereklidir	tip	Açıklama
group	Evet	Dize (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 Parametresi	gereklidir	tip	Açıklama
name	Hayır	Dize (RegExp desteklenir)	Ada göre bir etki alanında takma ad arayın
recipient	Hayır	Dize (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 Parametresi	gereklidir	tip	Açıklama
name	Evet	sicim	Takma ad
recipients	Evet	Dize veya Dizi	Alı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)
description	Hayır	sicim	Takma ad açıklaması
labels	Hayır	Dize veya Dizi	Etiketlerin listesi (satır sonu / boşluk / virgülle ayrılmış Dize veya Dizi olmalıdır)
has_recipient_verification	Hayır	Boole	Alı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_enabled	Hayır	Boole	Bu 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 Parametresi	gereklidir	tip	Açıklama
name	Hayır	sicim	Takma ad
recipients	Evet	Dize veya Dizi	Alı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)
description	Hayır	sicim	Takma ad açıklaması
labels	Hayır	Dize veya Dizi	Etiketlerin listesi (satır sonu / boşluk / virgülle ayrılmış Dize veya Dizi olmalıdır)
has_recipient_verification	Hayır	Boole	Alı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_enabled	Hayır	Boole	Bu 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: