API anahtarları
Kodunuzun Vivollo ile güvenli biçimde konuşmak için kullandığı kimlik bilgilerini oluşturun ve yönetin.
API anahtarı (API key), kodunuzun Vivollo çalışma alanınızla konuşma iznine sahip olduğunu kanıtlamak için kullandığı kimlik bilgisidir. Programatik olan her şey — REST API'yi sorgulamak, bir koleksiyona belge göndermek ya da bir betiğin kimliğini doğrulamak — bir tanesiyle başlar. Bu sayfa, anahtarları oluşturmayı, kullanmayı ve onlara göz kulak olmayı anlatıyor.
Anahtar oluşturmak
Developer alanında yeni bir API anahtarı oluşturun ve sonradan ne işe yaradığını hatırlamanız için ona açık bir açıklama (description) verin — "veri-ambarı eşitleme", "CMS yayımlayıcı". Anahtar oluşturulduğunda size token'ı gösterilir.
Ayrıca bir anahtara son kullanma tarihi (expiry) koyarak, seçtiğiniz bir tarihten sonra çalışmasını durdurabilirsiniz — geçici erişimler ya da kimlik bilgilerini düzenli aralıklarla yenilemek için pek kullanışlı.
Bir API anahtarına tıpkı bir parola gibi davranın — çünkü zaten tam olarak budur. Oluşturulduğu an güvenli bir yere kopyalayın, asla kod tabanınıza eklemeyin ya da bir mesajda paylaşmayın; ve bir anahtarın sızdığından şüphelenirseniz hemen iptal edip yenisini oluşturun.
Anahtar kullanmak
Bir isteğin kimliğini doğrulamak için anahtarı Authorization başlığında bir bearer
token olarak gönderin:
Authorization: Bearer YOUR_API_KEYHepsi bu — geçerli bir anahtar taşıyan her istek, sizin çalışma alanınızın içinde, yalnızca sizin verilerinize özel olarak çalışır; başkasınınkine değil.
Anahtarlarınızı yönetmek
Developer alanından anahtarlarınızı düzenli tutabilirsiniz:
- Hepsini görün — her anahtar, açıklamasıyla birlikte ve en son ne zaman kullanıldığı (artık hiçbir şeyin dayanmadığı anahtarları fark etmenin hızlı bir yolu).
- Bir anahtarı iptal edin — artık gerekmediği ya da ele geçmiş olabileceği an silin. İptal anında geçerli olur; o anahtarı hâlâ kullanan her kod çalışmayı durdurur, bu yüzden önce yenisini devreye alın.
İyi alışkanlıklar
Birkaç pratik, entegrasyonunuzu hem güvenli hem derli toplu tutar:
- Her entegrasyona ayrı bir anahtar. Ayrı işlere ayrı anahtarlar, birini iptal ederken diğerlerini bozmadığınız ve her anahtarın ne işe yaradığını her zaman bildiğiniz anlamına gelir.
- Düzenli aralıklarla yenileyin. Uzun ömürlü anahtarları arada bir değiştirin; yenilemeyi bir acil durum değil, rutin bir iş haline getirmek için son kullanma tarihlerinden yararlanın.
- Kullanılmayanları ayıklayın. Bir anahtar uzun zamandır kullanılmıyorsa, onu iptal etmek büyük olasılıkla güvenlidir — hatta daha güvenlidir.
Kaç anahtarınız olabilir
Aynı anda etkin tutabileceğiniz API anahtarı sayısı planınızın bir parçasıdır. Limite takılırsanız artık ihtiyaç duymadığınız bir anahtarı iptal edin ya da Planlar ve limitler sayfasına göz atın.
Elinizde bir anahtarla, bağlanmaya hazırsınız — ister olaylara tepki vererek, ister API'yi sorgulayarak.