Contents
the email tool that makes email marketing simple
- Guides and Tutorials
- API Anahtarınızı Oluşturun ve Yönetin
API Anahtarınızı Oluşturun ve Yönetin
Published: · Last updated: · By Marcus Biel
In brief
Maildroppa API anahtarını oluşturmayı, kopyalamayı, güvenle saklamayı, sunucu entegrasyonlarında kullanmayı, döndürmeyi ve silmeyi öğrenin.
API Anahtarı sayfası, harici bir sisteme hesabınızdaki desteklenen Maildroppa API uç noktalarına kimliği doğrulanmış erişim sağlar.
Bir API anahtarı oluşturabilir, anahtarın eksiksiz gizli değerini kopyalayabilir, anahtarı döndürerek güvenli bir şekilde sıfırlayabilir veya artık gerekmediğinde silebilirsiniz. Aynı hesap anahtarı, sunucu tarafı entegrasyonları ve Maildroppa Automations içindeki API request tetikleyicileri tarafından kullanılabilir.
API anahtarı, Maildroppa hesabınızı temsil eder. Anahtara sahip olan herkes, anahtarı döndürene veya silene kadar bu anahtarla kullanılabilen API uç noktalarını çağırabileceğinden, anahtarı parola gibi değerlendirin.
API Anahtarı Ne İçin Kullanılır?
Maildroppa dışındaki bir yazılımın etkileşimli kullanıcı girişi olmadan Maildroppa ile çalışması gerektiğinde API anahtarını kullanın.
Yaygın örnekler:
- Aboneleri bir CRM, mağaza, üyelik sistemi veya dahili veritabanıyla senkronize etmek.
- Sunucu tarafı bir uygulamadan aboneler oluşturmak veya güncellemek.
- Desteklenen uç noktalar üzerinden etiketleri, alanları, alan değerlerini ve segmentleri okumak veya yönetmek.
- Bir Automation içindeki API request tetikleyicisine özel etkinlikler göndermek.
- API üzerinden işlemsel Email Messages göndermek.
- API tabanlı webhook aboneliklerini yönetmek.
API anahtarı, sunucular arası iletişim için tasarlanmıştır. Ziyaretçinin tarayıcısında, herkese açık bir web sitesinde, mobil uygulamada veya gömülü kayıt formunda çalışan kodlar için tasarlanmamıştır.
Sayfa şu anda “beta” olarak işaretlenmiştir. API tarafından o anda desteklenen uç noktalar, istek gövdeleri, parametreler ve yanıt şemaları için bağlantılı OpenAPI belgelerini kaynak olarak kullanın.
API Anahtarı Sayfasını Açma
“Settings” seçeneğini açın, “Developers” bölümünü genişletin ve “API key” seçeneğini belirleyin.
Sayfayı doğrudan şu adresten de açabilirsiniz:
https://app.maildroppa.com/settings/developers/api-key
Sayfada şunlar bulunur:
- Beta rozeti bulunan bir API anahtarı paneli.
- “View OpenAPI docs” bağlantısı.
- Anahtar olmadığında boş durum ve “Create API key” düğmesi.
- Anahtar olduğunda mevcut anahtarın maskelenmiş gösterimi.
- Eksiksiz anahtarı kopyalayan “Copy” düğmesi.
- Mevcut anahtarı değiştirmek veya kaldırmak için “Rotate API key” ve “Delete API key” işlemleri.
Maildroppa, hesap başına bir API anahtarına izin verir. Sayfa; ayrı uygulamalar, ortamlar veya ekip üyeleri için ayrı anahtarlar oluşturmaz.
API Anahtarı Oluşturma
Sayfada “No API key yet” görüntülendiğinde “Create API key” seçeneğine tıklayın.
Maildroppa anahtarı hemen oluşturur. Bu ilk oluşturma işleminde onay iletişim kutusu yoktur. İstek çalışırken düğme “Creating API key” olarak değişir ve sayfa, anahtarla ilgili diğer işlemleri geçici olarak devre dışı bırakır.
Anahtar oluşturulduktan sonra:
- Boş durum kaybolur.
- Maskelenmiş bir anahtar görünür.
- “Copy”, “Rotate API key” ve “Delete API key” işlemleri kullanılabilir hale gelir.
- Maildroppa, “API key updated” başarı mesajını görüntüler.
Hesap için başka bir anahtar zaten varsa Maildroppa ikinci bir anahtar oluşturmaz. Mevcut anahtarı kullanın veya anahtarı döndürün.
Maskelenmiş Anahtarı Anlama
Sayfa, eksiksiz gizli değeri normal metin olarak göstermez. İlk beş karakteri ve ardından beş yıldız işaretini gösterir; örneğin:
a1b2c*****
Bu yalnızca görsel bir maskelemedir. Yıldız işaretleri anahtarın gerçek uzunluğunu göstermez ve maskelenmiş değer bir API isteğinde kullanılamaz.
Eksiksiz mevcut anahtarı panonuza yazmak için “Copy” seçeneğine tıklayın. Kopyalama başarılı olduktan sonra düğme kısa süreliğine “Copied!” olarak değişir.
Sayfaya döndüğünüzde anahtar maskeli kalır, ancak “Copy” eksiksiz mevcut değeri kopyalamaya devam eder. Bu nedenle, oluşturma sırasında kaydetmediğiniz için geçerli bir anahtarı döndürmeniz gerekmez.
Anahtarı Güvenli Saklama
Kopyaladığınız anahtarı doğrudan entegrasyon tarafından kullanılan gizli bilgi depolama alanına aktarın.
Uygun konumlar şunlardır:
- Yönetilen bir gizli bilgi yöneticisi.
- Korumalı sunucu ortam yapılandırması.
- Şifrelenmiş bir dağıtım gizli bilgisi.
- Operasyonel kurtarma için kullanılan bir parola yöneticisi.
Anahtarı şuralarda saklamayın:
- Tarayıcı tarafı JavaScript'te veya indirilebilir başka bir frontend paketinde.
- Bir depoya gönderilmiş herkese açık ya da özel kaynak kodu dosyasında.
- URL veya sorgu parametresinde.
- Herkese açık belgelerde, ekran görüntülerinde, destek mesajlarında veya sorun takip sistemlerinde.
- Paylaşılan uygulama günlüklerinde, analiz etkinliklerinde veya hata raporlarında.
- Şifrelenmemiş bir elektronik tabloda veya normal ekip sohbetinde.
Belgelere veya başkalarıyla paylaşılan kabuk geçmişine kopyalanacak bir curl örneğine anahtarı eklemeyin. Bunun yerine MAILDROPPA_API_KEY gibi bir ortam değişkeni kullanın.
API Anahtarını Kullanma
Eksiksiz anahtarı X-API-Key HTTP istek başlığında gönderin:
X-API-Key: your-complete-api-key
Anahtarı Bearer token olarak göndermeyin. Maildroppa Authorization: Bearer ... yerine X-API-Key bekler.
Üretim API'sine ve etkileşimli OpenAPI belgelerine şu adresten ulaşabilirsiniz:
Belgeleri yeni bir tarayıcı sekmesinde açmak için API Anahtarı sayfasında “View OpenAPI docs” seçeneğine tıklayın. Buradan bir uç nokta seçerek yöntemini, yolunu, parametrelerini, istek gövdesini, yanıt türünü ve olası durum kodlarını inceleyin.
Örnek İstek
Aşağıdaki örnek, abonelerin ilk sayfasını alır. Gizli bilgiyi doğrudan komuta yerleştirmek yerine anahtarı bir ortam değişkeninden okur:
curl --request GET \
--url 'https://api.maildroppa.com/subscribers?pageNumber=1' \
--header 'Accept: application/json' \
--header "X-API-Key: ${MAILDROPPA_API_KEY}"
Değişkeni entegrasyonun çalıştığı güvenli ortamda ayarlayın. Kesin yöntem, yol, sorgu parametreleri ve gövde uç noktaya bağlıdır. Bu ayrıntıları Maildroppa uygulamasındaki işlemlerden tahmin etmek yerine OpenAPI belgelerinden kopyalayın.
JSON Gövdeli İstekler
JSON gönderen bir isteğe ayrıca şunu ekleyin:
Content-Type: application/json
Örneğin temel yapı şöyledir:
curl --request POST \
--url 'https://api.maildroppa.com/example-endpoint' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header "X-API-Key: ${MAILDROPPA_API_KEY}" \
--data '{"example":"value"}'
/example-endpoint ve gövdesi yer tutucudur. Bunları belgelenmiş bir uç nokta ve belgelenmiş istek şemasıyla değiştirin.
Anahtarın Erişebileceği Şeyler
Anahtar yalnızca API anahtarı kimlik doğrulamasını destekleyen uç noktalarla çalışır. Maildroppa uygulaması tarafından dahili olarak kullanılan bir sayfa veya istek, otomatik olarak herkese açık müşteri API'sinin parçası değildir.
OpenAPI belgeleri desteklenen müşteri API'sini gösterir. Bir yol API anahtarı kullanımı için belgelenmemişse anahtarın bu yola erişebileceğini varsaymayın.
API Anahtarı sayfasında kapsamlar veya uç nokta bazında izin onay kutuları bulunmaz. Bu nedenle mevcut hesap anahtarı, bir entegrasyon yalnızca tek bir uç nokta kullansa bile yüksek değerli bir kimlik bilgisi olarak ele alınmalıdır.
Hız Sınırları
Mevcut OpenAPI sözleşmesi şu API anahtarı sınırlarını belgeler:
- Varsayılan müşteri API'si: dakikada 300 istek ve saatte 2.000 istek.
/eventsadresindeki Events API: saniyede 100 istek ve 500 istek burst kapasitesi.
Bu sınırlar, anahtarı paylaşan her komut dosyasına bağımsız olarak değil, Maildroppa hesabına uygulanır. Bu nedenle birden çok entegrasyon aynı kullanım hakkını tüketebilir.
Maildroppa 429 Too Many Requests döndürdüğünde yeni istek göndermeyi durdurun ve mevcutsa Retry-After yanıt başlığına uyun. Çok sayıda paralel yeniden deneme başlatmak yerine kuyruk ve kontrollü geri çekilme kullanın.
API beta aşamasındayken hız sınırı politikaları değişebilir. Yüksek hacimli entegrasyonlar tasarlamadan önce OpenAPI belgelerinin üst kısmındaki bilgileri kontrol edin.
Anahtarı Automation API İstekleri İçin Kullanma
Sisteminiz Maildroppa'nın Events API'sine özel bir etkinlik gönderdiğinde bir Automation başlayabilir.
Bir “API request” tetikleyicisi yapılandırdığınızda Maildroppa, bu sayfadan yönetilen aynı hesap API anahtarını kullanır. Tetikleyici kurulumu, anahtar yoksa anahtarı oluşturabilir ve eksiksiz anahtarı içeren hazırlanmış bir curl isteğini kopyalayabilir.
Bunun iki önemli sonucu vardır:
- Hesap anahtarını döndürmek veya silmek, Automations'a özel etkinlik gönderen sistemleri de etkiler.
- Kopyalanan bir Automation istek örneği, anahtar ekranda maskelenmiş olsa bile gizli bilgiyi panoda barındırır.
Anahtarı döndürmeden veya silmeden önce tüm API request tetikleyicilerini ve harici etkinlik gönderenleri entegrasyon envanterinize dahil edin.
API Anahtarını Sıfırlama veya Değiştirme
Mevcut kimlik bilgisini sıfırlamanız veya değiştirmeniz gerektiğinde “Rotate API key” seçeneğini kullanın. Maildroppa aynı işlem kapsamında yeni bir anahtar oluşturur ve önceki anahtarı geçersiz kılar.
Şu durumlarda anahtarı döndürün:
- Anahtar açığa çıkmış olabilir.
- Anahtarı bilen bir kişi veya sağlayıcının artık erişime ihtiyacı yoktur.
- Güvenlik politikanız düzenli kimlik bilgisi değişimi gerektirir.
- Eski veya güvensiz bir konumda saklanan anahtarı değiştirmek istiyorsunuz.
Maskelenmiş anahtarın altındaki “Rotate API key” seçeneğine tıklayın. Maildroppa, mevcut anahtarın artık kullanılamayacağını açıklayan bir uyarı iletişim kutusu açar.
Devam etmek için iletişim kutusundaki “Rotate API key” seçeneğine, mevcut anahtarı korumak için “Cancel” seçeneğine tıklayın.
Döndürme İşleminde Bekleme Süresi Yoktur
Döndürme işlemini onayladıktan sonra eski anahtar hemen çalışmayı durdurur. Maildroppa eski ve yeni anahtarları aynı anda geçerli tutmaz.
Hesapta yalnızca bir anahtar bulunduğundan döndürme işlemi, bu anahtarı kullanan tüm sunucuları, zamanlanmış işleri, entegrasyonları, komut dosyalarını ve Automation etkinlik göndericilerini etkiler.
Planlı bir döndürme işlemi için şu sırayı izleyin:
- Mevcut anahtarı kullanan tüm entegrasyonları listeleyin.
- Her entegrasyonun gizli yapılandırmasına ve dağıtım sürecine erişim hazırlayın.
- Kesintisiz API erişimi önemliyse kısa bir bakım aralığı belirleyin.
- “Rotate API key” seçeneğine tıklayın, ardından iletişim kutusunda “Rotate API key” seçeneğiyle uyarıyı onaylayın.
- Eksiksiz yeni anahtarı kopyalamak için “Copy” seçeneğine tıklayın.
- Her entegrasyondaki gizli bilgiyi hemen değiştirin.
- Gizli bilgileri yalnızca başlangıçta yükleyen hizmetleri yeniden başlatın veya yeniden dağıtın.
- Her entegrasyonu doğrulamak için zararsız ve belgelenmiş bir istek gönderin.
- Eski anahtarı kullanan ve unutulmuş bir hizmetten gelen
401 Unauthorizedyanıtlarını kontrol edin.
Mevcut anahtarın ele geçirildiğine inanıyorsanız hemen döndürün ve meşru sistemleri güncellemek için gereken kısa kesintiyi kabul edin.
API Anahtarını Silme
Hesabın API anahtarıyla kimlik doğrulanan istekleri artık kabul etmemesi gerektiğinde anahtarı silin.
Maskelenmiş anahtarın altındaki “Delete API key” seçeneğine tıklayın. Maildroppa, anahtarın hesaptan kalıcı olarak kaldırılacağını açıklayan bir uyarı iletişim kutusu açar.
Silmek için iletişim kutusundaki “Delete API key” seçeneğine, korumak için “Cancel” seçeneğine tıklayın.
Silme işleminden sonra:
- Mevcut anahtar hemen çalışmayı durdurur.
- Sayfa “No API key yet” durumuna döner.
- Silinen anahtarı kullanan sunucu entegrasyonları artık kimlik doğrulaması yapamaz.
- Bu anahtarı kullanan Automation API request göndericileri artık etkinlik iletemez.
Bir anahtarı silmek aboneleri, kampanyaları, etiketleri, alanları, segmentleri, Automations'ı veya diğer hesap verilerini silmez. Yalnızca desteklenen API uç noktalarına erişmek için kullanılan kimlik bilgisini kaldırır.
Yeni bir kimlik bilgisi oluşturmak için daha sonra “Create API key” seçeneğine tıklayabilirsiniz. Silinen değer geri yüklenmez. Yeni anahtarı kullanabilmesi için her entegrasyonun güncellenmesi gerekir.
Sıfırlama mı, Silme mi: Hangisini Seçmelisiniz?
API erişiminin yeni bir kimlik bilgisiyle devam etmesi gerekiyorsa “Rotate API key” seçeneğini belirleyin.
API erişiminin, en azından şimdilik, tamamen durması gerekiyorsa silme işlemini seçin.
Her iki işlem de mevcut anahtarı hemen geçersiz kılar. Döndürme işlemi aynı işlemin parçası olarak yenisini oluşturur; silme işlemi hesabı anahtarsız bırakır.
Güvenlik Önerileri
API Çağrılarını Sunucunuzda Tutun
Bir tarayıcı veya mobil uygulama, içine gömülmüş bir gizli bilgiyi güvenilir şekilde koruyamaz. Kullanıcı uygulamayı, istek başlıklarını, kaynak haritalarını veya ağ trafiğini inceleyerek anahtarı çıkarabilir.
Bir web sitesi veya uygulamanın bir işlemi tetiklemesi gerekiyorsa isteği önce kendi kimliği doğrulanmış backend'inize gönderin. Backend'in kullanıcıyı doğrulamasını ve sunucuda saklanan anahtarla Maildroppa'yı çağırmasını sağlayın.
Maruziyeti Mümkün Olduğunca Azaltın
Anahtarı yalnızca ihtiyaç duyan sistemlere verin. Anahtarı her geliştiriciye dağıtmayın veya birden çok yerel yapılandırma dosyasına yapıştırmayın.
Sayfa şu anda birden çok adlandırılmış veya kapsamlandırılmış anahtar yerine hesap genelinde tek bir anahtarı yönettiğinden, birkaç uygulamanın birbirinden daha güçlü şekilde izole edilmesi gerekiyorsa dahili bir entegrasyon hizmeti veya proxy kullanın.
İstek Başlıklarını Maskeleyin
HTTP istemcilerini, ters proxy'leri, gözlemlenebilirlik araçlarını ve hata raporlayıcılarını X-API-Key değerini maskeleyecek şekilde yapılandırın. Bir istek doğru çalışırken kimlik bilgisini hata ayıklama günlükleri üzerinden sızdırabilir.
Ortamları Birbirinden Ayrı Tutun
Üretim anahtarını yerel geliştirmede, örnek kodda, ekran görüntülerinde veya test armatürlerinde yeniden kullanmayın. Ortama özgü gizli bilgileri ortama özgü gizli bilgi depolarında saklayın.
“View OpenAPI docs” bağlantısı, üretim kullanıcılarını otomatik olarak üretim API belgelerine yönlendirir. Gerçek bir anahtar göndermeden önce ana bilgisayar adını her zaman doğrulayın.
Şüpheli Her Maruziyetten Sonra Döndürün
Bir mesajı, depo kaydını, günlük satırını veya ekran görüntüsünü silmek, kimsenin anahtarı kopyalamadığını kanıtlamaz. Eksiksiz değer açığa çıktıysa anahtarı döndürün.
API Hatalarını Ele Alma
Entegrasyonun ne yapması gerektiğine karar vermek için HTTP durumunu ve belgelenmiş yanıt gövdesini kullanın.
Yaygın durumlar şunlardır:
400 Bad Request— Yol, parametre veya JSON gövdesi uç nokta sözleşmesine uymuyor. İsteği OpenAPI şemasıyla karşılaştırın.401 Unauthorized—X-API-Keybaşlığı eksik, boş, geçersiz veya silinmiş ya da döndürme sonrasında eski bir değer içeriyor.403 Forbidden— Kimliği doğrulanmış anahtarın bu işlemi kullanmasına izin verilmiyor.404 Not Found— Yol veya başvurulan kaynak bu hesapta bulunmuyor.429 Too Many Requests— Entegrasyon bir API hız sınırına ulaştı. İstekleri duraklatın ve mevcutsaRetry-Afterbaşlığına uyun.5xx— Maildroppa isteği tamamlayamadı. API anahtarını içermeyen günlük kaydıyla, güvenli işlemleri sınırlı üstel geri çekilmeyle yeniden deneyin.
Her hatayı körü körüne yeniden denemeyin. Aynı isteği tekrar göndermeden önce 400, 401, 403 ve çoğu 404 yanıtını düzeltin.
Değişiklik yapan isteklerde bir isteği otomatik olarak tekrarlamadan önce uç noktanın yeniden deneme ve idempotency davranışını doğrulayın. Bağlantı hatası, Maildroppa'nın hiçbir değişiklik yapmadığını her zaman kanıtlamaz.
Sorun Giderme
“Create API key” Hâlâ Görünüyor
Hesapta şu anda anahtar yoktur. Düğmeye bir kez tıklayın ve isteğin tamamlanmasını bekleyin.
Oluşturma başarısız olursa yeniden denemeden önce sayfayı yenileyin. Başka bir sayfa veya Automation kurulumu hesap anahtarını zaten oluşturmuş olabilir.
Sayfadaki Anahtar Çok Kısa Görünüyor
Sayfa kasıtlı olarak yalnızca ilk beş karakteri ve ***** ifadesini gösterir. Eksiksiz değeri kopyalamak için “Copy” seçeneğine tıklayın. Maskelenmiş metni bir istekte göndermeyin.
“Copy”, “Copied!” Olarak Değişmiyor
Tarayıcı pano erişimini engellemiş olabilir. Sayfayı etkin sekmede tutun, istenirse pano erişimine izin verin ve “Copy” seçeneğine tekrar tıklayın.
Anahtarı maskelenmiş metinden yeniden oluşturmaya çalışmayın.
Bir İstek 401 Unauthorized Döndürüyor
Şunları kontrol edin:
- Başlık adının tam olarak
X-API-Keyolduğundan emin olun. - Başlığın, görünen yıldız işaretleri olmadan eksiksiz değeri içerdiğinden emin olun.
- Entegrasyonun bunun yerine
Authorization: Bearergöndermediğinden emin olun. - Gizli bilgiye boşluk, tırnak işareti veya yeni satır eklenmediğinden emin olun.
- Hiç kimsenin hesap anahtarını döndürmediğini veya silmediğini kontrol edin.
- Ortam değişkenlerini yalnızca başlangıçta okuyorsa hizmetin yeniden başlatıldığından emin olun.
- İsteğin doğru Maildroppa API ortamına gönderildiğini kontrol edin.
Bir Entegrasyon Çalışıyor, Ancak Diğeri Döndürme Sonrasında Durdu
İkinci entegrasyon muhtemelen hâlâ eski anahtarı kullanıyor. Bir örtüşme süresi yoktur. Gizli bilgisini güncelleyin ve yapılandırmayı önbelleğe alan işlemleri yeniden başlatın.
OpenAPI Sayfası Çalışıyor, Ancak Bir Uç Nokta 403 Döndürüyor
Her uygulama uç noktası API anahtarı kimlik doğrulamasını desteklemez. Müşteri API'si için belgelenmiş bir işlem kullanın ve OpenAPI sayfasındaki kimlik doğrulama gereksinimlerini doğrulayın.
İstekler 429 Too Many Requests Döndürüyor
İstek yoğunluğunu azaltın, işleri kuyruğa alın ve API tarafından döndürülen gecikmeden sonra yeniden deneyin. Paralel yeniden deneme fırtınalarından kaçının. Birden çok uygulama aynı hesap anahtarını paylaşıyorsa istek hacimlerini koordine edin; çünkü hesabın API sınırlarını paylaşırlar.
Önerilen Kurulum Kontrol Listesi
Bir entegrasyonu düzenli kullanıma almadan önce şunları doğrulayın:
- Anahtar yalnızca sunucu tarafı gizli bilgi yapılandırmasında saklanıyor.
- İstekler
X-API-Keybaşlığını kullanıyor. - Entegrasyon üretimde
https://api.maildroppa.comkullanıyor. - Her yöntem, yol, parametre ve JSON gövdesi OpenAPI belgelerini izliyor.
- Günlükler ve hata raporları anahtarı maskeliyor.
- Zaman aşımları ve sınırlı yeniden denemeler yapılandırılmış.
401,403,429ve sunucu hataları izleniyor.- Entegrasyonun sahibi kaydedilmiş.
- Hesap anahtarını paylaşan her sistem döndürme planına dahil edilmiş.
- Ele geçirilmiş bir anahtar hızlıca döndürülebiliyor.
API Anahtarı sayfası kasıtlı olarak küçüktür, ancak işlemleri hesaba bağlı her API entegrasyonunu etkiler. Anahtarı yalnızca gerektiğinde oluşturun, güvenilir sunucularda tutun ve döndürmeyi hesap genelinde bir kimlik bilgisi değişikliği olarak planlayın.
Ready to Send Better Emails?
Stop juggling bloated tools or overpriced plans. Maildroppa offers personal support, GDPR-level privacy, and powerful email marketing - starting free forever.
No credit card required. No time limit.