Abonelik anahtarıyla API çağırma
Bir API yayımladığınızda ağ geçidi üzerinden erişim sağlayabilecek kişiler konusunda denetime sahip olmak istersiniz. Abonelik anahtarları, BIR API'ye erişimi kısıtlamanın bir yoludur.
Burada, API'lerinizin güvenliğini sağlamak için abonelik anahtarlarını kullanmayı öğreneceksiniz.
Abonelikler ve anahtarlar
API'lerinizi korumak için bir abonelik anahtarı kullanabilirsiniz.
Dekont
Üretim API Management ortamlarında, api'lerinizi sertifika kimlik doğrulaması veya OAuth 2.0 yetkilendirmesi gibi yetkisiz kullanıma karşı korumak için genellikle bir abonelik anahtarını diğer mekanizmalarla birleştirirsiniz. Bunlar bu modülün kapsamı dışındadır.
Abonelik anahtarı, istemci isteğinin üst bilgilerinde veya URL'de sorgu dizesi olarak geçirilen benzersiz bir otomatik oluşturulan dizedir. Anahtar, izinler ve ilkeler üzerinde ayrıntılı denetim sağlayan, kapsamı farklı alanlara göre ayarlanabilen bir abonelikle doğrudan ilgilidir. Ana abonelik kapsamları şunlardır:
- Tüm API'ler
- Tek bir API
- Ürün
Korumalı API'yi çağıran bir uygulama isteğin anahtarını içermelidir.
Bu abonelik anahtarlarını istediğiniz zaman yeniden oluşturabilirsiniz. Örneğin, bir anahtarın yetkisiz kullanıcılarla paylaşıldığından şüpheleniyorsanız abonelik anahtarlarını yeniden üretin.
Her abonelik birincil ve ikincil olmak üzere iki anahtara sahiptir. İki anahtara sahip olmak, bir anahtarı yeniden oluşturmanız gerektiğinde bunu kolaylaştırır. Örneğin kesinti yaşamadan birincil anahtarı değiştirmek için uygulamalarınızda ikincil anahtarı kullanabilirsiniz.
Aboneliklerin etkinleştirildiği ürünlerde API çağrısı yaparken bir anahtar sağlamanız gerekir. Geliştiriciler abonelik isteği göndererek anahtar alabilir. Bu işlem API Management iş akışının temel bir parçasıdır.
Dekont
Api'ye erişebilmeleri için yeni kullanıcılar oluşturmak ve onlara abonelik anahtarlarını vermek API Management iş akışının temel bir parçasıdır, ancak bu modülün kapsamı dışındadır.
Abonelik anahtarıyla API çağırma
Bir abonelikle korunan API uç noktalarına çağrı yapan uygulamaların HTTP isteklerinde geçerli bir anahtar kullanması gerekir. Anahtarlar istek üst bilgisinde veya URL'de sorgu dizesi olarak geçirilebilir.
Varsayılan üst bilgi adı Ocp-Apim-Subscription-Key, varsayılan sorgu dizesi ise subscription-key şeklindedir.
API çağrılarınızı test etmek için geliştirici portalını (hizmet katmanınızda kullanılabiliyorsa), curl gibi bir komut satırı aracını veya Postman gibi diğer araçları kullanabilirsiniz.
aşağıda curl komutunu kullanarak istek üst bilgisinde bir anahtar geçiren bir GET isteği örneği verilmiştir:
curl --header "Ocp-Apim-Subscription-Key: <key string>" https://<apim gateway>.azure-api.net/api/path
Anahtarı URL'de sorgu dizesi olarak geçiren örnek bir curl komutu aşağıda verilmiştir:
curl https://<apim gateway>.azure-api.net/api/path?subscription-key=<key string>
Anahtar üst bilgide veya URL'de sorgu dizesi olarak geçirilmiyorsa API ağ geçidinden 401 Erişim Reddedildi yanıtı alırsınız.