E-posta Yönlendirme API'sı

İçindekiler

Kütüphaneler
Temel URI
Kimlik Doğrulama
Hatalar
yerelleştirme
sayfalara numara koyma
hesap
Alanlar
Davet etmek
Üyeler
- Alan adını güncelleyin
- Etki alanı üyesini kaldır
Takma adlar

Kütüphaneler

Şu anda henüz herhangi bir API sarmalayıcısı yayınlamadık, ancak bunu yakın gelecekte yapmayı planlıyoruz. Adresine e-posta gönderinapi@forwardemail.net belirli bir programlama dilinin API sarmalayıcısı serbest bırakıldığında size bildirimde bulunulmasını istiyorsanız. Bu arada, bu önerilen HTTP istek kitaplıklarını uygulamanızda kullanabilir veyabukle 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
.AĞ	RestSharp

Temel URI

Geçerli HTTP temel URI yolu:https://api.forwardemail.net. Eski HTTP temel URI yoluhttps://forwardemail.net:4000 is deprecated as of January 1, 2021.

Kimlik Doğrulama

Tüm uç noktalar içinücretsiz API anahtarı 🎉 to be set as the "username" value of the request's Temel Yetkilendirme başlığı. Endişelenmeyin - bunun ne olduğundan emin değilseniz, örnekler aşağıda verilmiştir.

Hatalar

Herhangi bir hata oluşursa, API isteğinin yanıt gövdesi ayrıntılı bir hata mesajı içerir. API'leri yazma ve belgeleme konusunda on yılı aşkın deneyime sahip olmanın yanı sıra,çizgili en beautiful API documentation when we crafted ours 😄.

kod	ad
200	tamam
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ı

Tip: If you receive a 5xx status code (which should not happen), then please contact us at api@forwardemail.net and we will help you to resolve your issue immediately.

yerelleştirme

Hizmetimiz 25'in üzerinde farklı dile çevrilmiştir. Tüm API yanıt mesajları, API isteği yapan kullanıcının tespit ettiği son yerel ayara çevrilir. Özel bir veri ileterek bunu geçersiz kılabilirsinizAccept-Language başlığı. Bu sayfanın altındaki dil açılır menüsünü kullanarak denemekten çekinmeyin.

sayfalara numara koyma

Sayfalandırma kullanılabilir olduğunda bilgilendirilmek istiyorsanız, lütfen e-posta ile gönderinapi@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

Tip: Domain endpoints with a domain's name /v1/domains/:domain_name as their path are interchangeable with a domain's ID :domain_id. This means you can refer to the domain by either its name or id value.

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"`)
`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 geçirilirse, alıcı olarak kullanılacak sınırlandırılmış e-posta adresleri listesidir (satır sonu, boşluk ve / veya virgülle ayrılmış)

Ö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 iletimi için yapılandırılacak özel bağlantı noktası (varsayılan değer`"25"`)

Ö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ıyı etki alanı üyeliğine eklenecek grupla (`"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 grupla (`"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ı alma

GET /v1/domains/example.com/aliases

Ö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)
`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ı 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)
`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:

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

API Belgeleri

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ı alma

Yeni alan takma adı oluştur

Alan takma adını güncelleme

Alan takma adını sil