Bilgi bankası

API anahtarları

Her iş için bir anahtar, yalnızca gereken izin ve gönderenlerle, her çağrı kayıtlı.

Ayrıntılar

Sahibi olduğunuz bir çalışma alanında Ayarlar → API anahtarları bölümünden oluşturulur. Gizli anahtar bir kez gösterilir ve her anahtar bir oe_live_ anahtarıdır.
Bir anahtar yalnızca seçtiğiniz izinleri taşır, yenisi emails:send ile başlar. Bir rol de taşıyabilir; bu ikinci bir yetki değil, bir tavandır: GET /ping anahtarın adlandırdığı izinleri ve rolün ona bıraktıklarını döndürür, böylece anahtarın açıkça sahip olduğu bir izin için gelen 403’ün görünür bir nedeni olur.
Gönderim kapsamı 25 tam alan adına ve 50 tekil adrese kadar içerir. Tam alan adı sonradan eklenen adresleri de kapsar, listenin dışındaki bir gönderen 403 ile reddedilir.
İsteğe bağlı bir süre sonu, anahtarın kendiliğinden sona ermesini sağlar; on yıla kadar ileriye.
Yenileme yalnızca gizli değeri değiştirir: kimlik, izinler, gönderim kapsamı ve istek geçmişi sürer, eski gizli değer yenisi oluşturulduğu anda çalışmayı bırakır. keys:write izni olan bir anahtar kendini API üzerinden yenileyebilir. İptal bir güncellemedir, silme değildir; bu yüzden sonraki bir çağrıya revoked_api_key denir.
Her kimliği doğrulanmış çağrı yöntemi, yolu, durumu, hata kodu, süresi, IP’si ve kullanıcı aracısıyla kaydedilir; gövde ya da sorgu dizesi asla. Anahtar sayfası bunu Analiz, Etkinlik ve İstekler olarak gösterir: en yoğun rotalar, ne sıklıkla başarısız oldukları ve ortanca gecikmeleri; aynı görünümler birden çok anahtarı aynı anda kapsar. Günlük budanmaz, saklanır.
Sayfanın yaptığı her şey API ve SDK üzerinden de yapılabilir: GET /keys ve GET /keys/{id} anahtarları gizli değerleri olmadan okur, POST /keys bir anahtar oluşturur, PATCH /keys/{id} onu yeniden adlandırır, kapsamlarını veya gönderim kapsamını değiştirir, kapatıp yeniden açar, rotate, revoke ve delete de adlarının söylediğini yapar. İstek günlüğü ve etkinlik de aynı şekilde, tek bir anahtar ya da hepsi için, sayfanın filtreleriyle okunur. Okumak keys:read, her değişiklik keys:manage ister; bu iki kapsamı biri vermedikçe hiçbir anahtar taşımaz. MCP sunucusu da günlüğü ve etkinliği listApiKeyRequests ve listApiKeyActivity olarak okur.
Bir anahtar kendisinden geniş bir anahtar asla oluşturmaz ve ona asla ulaşmaz: kapsamları, rolü, süresi, modu ve gönderim kapsamı, çağrıyı yapan anahtarın içinde kalmak zorundadır. Ek doğrulama bir anahtarla yapılan çağrıya uygulanamaz, bu yüzden keys:manage kimlik bilgisi üreten bir kimlik bilgisidir. Onu yalnızca anahtar üreten bir otomasyona, kendine ait bir rol, gönderim kapsamı ve süreyle verin ve yaptığı her şeyin ona kaydedildiği Etkinlik sekmesini izleyin.
Eksik olanlar: bir anahtar IP adreslerine bağlanamaz ve test modu anahtarı oluşturulamaz.