API anahtarları
Her iş için bir anahtar, fazlası değil.
Her hizmete yalnızca gereken izin ve gönderenleri taşıyan kendi anahtarını verin. Yaptığı her çağrı kayda geçer.
Kısaca
API anahtarı nedir?
Kodunuzun her istekle gönderdiği bir gizli değer. Çağrının hangi çalışma alanı için olduğunu ve neye izni olduğunu söyler.
32
seçilebilecek izin
25
tek gönderim kapsamında tam alan adı
3,650
gün, en uzun geçerlilik
Nasıl çalışır
Tavan olarak bir rol
Bir rol bağlayın, anahtar onun izin verdiğinden fazlasını asla yapamaz. GET /ping anahtarın ne istediğini ve rolün ona ne bıraktığını gösterir.
Kimin adına gönderdiğini sınırlayın
25 tam alan adına ve 50 tekil adrese kadar. Bunların dışındaki bir gönderen 403 alır.
Her çağrı kayıtta
Her isteğin yöntemi, yolu, durumu, hatası ve süresi; en yoğun rotalar ve ne sıklıkla başarısız oldukları.
Bir anahtarın neler yapabildiğine bakın
GET /ping izin gerektirmez ve anahtarın erişimini döndürür.
{ "ok": true, "keyId": "4c1b257a66287fd113bd89d0", "mode": "live", "scopes": ["emails:send", "templates:write", "members:write"], "roleId": "role_2b81de079c1f0a4b7e05d386", "grantedScopes": ["emails:send", "templates:write"], "workspaceId": "10417196-e324-4283-af98-66ec62167c47"}Neler sunar
Bugün üründe
Yerinde yenileyin
Aynı kimlik, izinler ve geçmişle yeni bir gizli değer.
İptal, silme değil
Sonraki bir çağrıya revoked_api_key denir.
Süre sonu yerleşik
Bir anahtarın süresini on yıla kadar ileriye ayarlayın.
İyi uygulamalar
En iyi şekilde kullanmak
- 01
Hizmet başına bir anahtar
Böylece bir sızıntı hepsine değil, tek bir entegrasyona mal olur.
- 02
En azını verin
emails:send ile başlayın, bir çağrı gerektirdiğinde izin ekleyin.
- 03
Hataları izleyin
Bir dağıtımdan sonra istek günlüğünü başarısız çağrılara göre süzün.
Şu anki durum
Bilmekte fayda var
- IP izin listesi yok
- Bir anahtar henüz sunucularınızın adreslerine bağlanamaz.
- Test anahtarı yok
- Yalnızca oe_live_ anahtarları oluşturulabilir, bu yüzden her gönderim gerçektir.
- API üzerinden günlük yok
- İstek günlüğü bir REST rotasından değil, uygulamada okunur.
Sorular
Sık sorulanlar
Devam edin
Şunlarla iyi çalışır
Başlayın
Alan adınız,
postanız.
Bir alan adını OpenEmail'e yönlendirin ve postasını onun etrafında kurulmuş bir posta kutusunda okuyun. Ücretsiz plan bir alan adını kapsar.
