Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi
Aşağıdaki bölümlerde API ürünleri ve ilgili temel kavramlar tanıtılmaktadır.
API ürünü nedir?
API sağlayıcısı olarak, API'lerinizi paket haline getirmek ve bunları uygulama geliştiricilerin kullanımına sunmak için API ürünleri oluşturursunuz. API ürünlerini ürün seriniz olarak düşünebilirsiniz.
Daha ayrıntılı olarak belirtmek gerekirse, bir API ürünü aşağıdaki öğeleri bir arada gruplandırır:
- API kaynaklarının (URI'ler) toplanması
- Hizmet planı
- İzleme veya analiz için işletmenize özel meta veriler (isteğe bağlı)
Bir API ürününde paket haline getirilmiş API kaynakları, bir veya daha fazla API'den gelebilir. Böylece aşağıdaki şekilde gösterildiği gibi özel özellik grupları oluşturmak için kaynakları karıştırıp eşleştirebilirsiniz.
Belirli ihtiyaçları çözen kullanım alanlarını ele almak için birden fazla API ürünü oluşturabilirsiniz. Örneğin, geliştiricilerin haritaları uygulamalarına kolayca entegre edebilmesi için çok sayıda harita kaynağını bir araya getiren bir API ürünü oluşturabilirsiniz. Ayrıca her API ürününde farklı fiyatlandırma seviyeleri gibi farklı özellikler ayarlayabilirsiniz. Örneğin, aşağıdaki API ürün kombinasyonlarını sunabilirsiniz:
- Uygun fiyata düşük bir erişim sınırı (ör. günde 1.000 istek) sunan bir API ürünü. Aynı kaynaklara erişim sunan, ancak erişim sınırı ve fiyatı daha yüksek olan ikinci bir API ürünü.
- Kaynaklara salt okuma erişimi sunan ücretsiz bir API ürünü. Küçük bir ücret karşılığında aynı kaynaklara okuma/yazma erişimi sağlayan ikinci bir API ürünü.
Ayrıca, bir API ürünündeki API kaynaklarına erişimi kontrol edebilirsiniz. Örneğin, yalnızca şirket içi geliştiricilerin veya yalnızca ödeme yapan müşterilerin erişebileceği kaynakları bir araya getirebilirsiniz.
API ürünleri, API'leriniz için yetkilendirme ve erişim kontrolü için merkezi mekanizmadır. Apigee'de API anahtarları API'ler için değil, API ürünleri için sağlanır. Başka bir deyişle, API anahtarları ekli bir hizmet planına sahip kaynak paketleri için sağlanır.
Uygulama geliştiriciler, Uygulama kaydetme bölümünde açıklandığı gibi, uygulamalarını kaydederek API ürünlerinize erişir. Bir uygulama bir API ürününe erişmeye çalıştığında, aşağıdakilerden emin olmak için Apigee çalışma zamanında yetkilendirme zorunlu kılınır:
- İstekte bulunan uygulamanın belirli bir API kaynağına erişmesine izin verilir.
- İstekte bulunan uygulama, izin verilen kotayı aşmamıştır.
- Tanımlanırsa API ürününde tanımlanan OAuth kapsamları, uygulamanın sunduğu erişim jetonuyla ilişkili olan kapsamlarla eşleşir.
Temel kavramları anlama
API ürünlerinizi oluşturmadan önce aşağıdaki temel kavramları inceleyin.
- API anahtarları
- Otomatik ve manuel anahtar onayı karşılaştırması
- Kotalar
- OAuth kapsamları
- Erişim düzeyleri
API anahtarları
Bir geliştiricinin uygulamasını kuruluşunuza kaydettiğinizde, uygulamanın en az bir API ürünüyle ilişkilendirilmesi gerekir. Bir uygulamanın bir veya daha fazla API ürünüyle eşlenmesinin sonucunda Edge, uygulamaya benzersiz bir tüketici anahtarı atar.
Tüketici anahtarı veya erişim jetonu, istek kimlik bilgileri olarak görev yapar. Uygulama geliştirici, tüketici anahtarını uygulamaya yerleştirir. Böylece uygulama, Edge tarafından barındırılan bir API'ye istek gönderdiğinde, uygulama tüketici anahtarını aşağıdaki yöntemlerden birini kullanarak istekte geçirir:
- API, API anahtarı doğrulamasını kullandığında uygulamanın tüketici anahtarını doğrudan iletmesi gerekir.
- API, OAuth Jetonu doğrulamasını kullandığında, uygulamanın tüketici anahtarından türetilmiş bir jetonu iletmesi gerekir.
API anahtarı zorunlu kılma işlemi otomatik olarak gerçekleştirilmez. API Proxy'si, istek kimlik bilgileri olarak tüketici anahtarını veya OAuth jetonlarını kullanırken API proxy'lerinizdeki istek kimlik bilgilerini uygun akışta bir VerifyAPIKey politikası veya OAuth/VerifyAccessToken politikası ekleyerek doğrular. API Proxy'nize kimlik bilgisi zorunlu kılma politikası eklemezseniz herhangi bir arayan API'lerinizi çağırabilir. Daha fazla bilgi için API Anahtarı politikasını doğrulama bölümüne bakın.
Edge, istekte geçirilen kimlik bilgilerini doğrulamak için aşağıdaki adımları gerçekleştirir:
- İstekle birlikte iletilen kimlik bilgilerini alın. OAuth jetonu doğrulaması durumunda Edge, jetonun süresinin dolmadığını doğrular ve ardından jetonu oluşturmak için kullanılan tüketici anahtarını arar.
- Tüketici anahtarının ilişkilendirildiği API ürünlerinin listesini alın.
- Mevcut API Proxy'sinin API Ürününe eklendiğini ve mevcut kaynak yolunun (URL yolu) API Ürününde etkin olup olmadığını onaylayın.
- Tüketici anahtarının süresinin dolmadığını veya iptal edilmediğini doğrulayın, uygulamanın iptal edilmediğinden ve uygulama geliştiricinin etkin olduğundan emin olun.
Yukarıdaki kontrollerin tümü başarılı olursa kimlik bilgisi doğrulaması başarılı olur.
Sonuç olarak Edge, tüketici anahtarlarını otomatik olarak oluşturur ancak API yayıncılarının uygun politikalar kullanarak API proxy'lerinde anahtar kontrolünü zorunlu kılması gerekir.
Otomatik onay ile manuel onay karşılaştırması
Varsayılan olarak, bir uygulamadan API ürününe erişmek için anahtar almaya yönelik tüm istekler otomatik olarak onaylanır. Alternatif olarak API ürününü, anahtarları manuel olarak onaylayacak şekilde yapılandırabilirsiniz. Bu durumda, API ürününü ekleyen tüm uygulamalardan gelen anahtar isteklerini onaylamanız gerekir. Daha fazla bilgi için Uygulamaları kaydetme ve API anahtarlarını yönetme konusuna bakın.
Kotalar
Kotalar, arka uç sunucularınızı yüksek trafik için koruyabilir ve ürün serinizi farklılaştırabilir. Örneğin, kaynakları bir premium ürün olarak yüksek bir kotaya sahip olacak şekilde bir arada paket haline getirmek ve aynı paketi temel ürün olarak daha düşük bir kotayla kullanmak isteyebilirsiniz. Kota, bir ürün popülerse ve çok sayıda istek alıyorsa sunucularınızın yorulmasını önlemeye yardımcı olabilir.
Kota yapılandırma hakkında bilgi edinmek için Kota politikası bölümüne bakın. Kota politikalarında ürün kota ayarlarını kullanma hakkında bilgi için şu topluluk makalesine bakın: Bir API ürünündeki kota ayarları, API proxy'sindeki kota politikalarıyla nasıl etkileşime girer?
OAuth kapsamları
Ek bir güvenlik düzeyi olarak, ürün üzerinden gönderilen erişim jetonlarında bulunması gereken tüm OAuth kapsamlarını virgülle ayrılmış bir liste olarak tanımlayabilirsiniz. Ürün oluştururken kuruluşunuzun kullandığı tüm kapsamları bilmeniz gerekir. Bir ürüne eklediğiniz kapsamlar mevcut kapsamlarla eşleşmelidir. Aksi takdirde ürün güvenli değildir.
Kapsamları Edge OAuth politikalarıyla kullanma hakkında daha fazla bilgi edinmek için OAuth2 kapsamlarıyla çalışma başlıklı makaleyi inceleyin.
Erişim düzeyleri
Bir API ürünü tanımlarken aşağıdaki erişim düzeylerini ayarlayabilirsiniz.
| Erişim düzeyi | Açıklama |
|---|---|
| Herkese açık | Tüm geliştiricilerin kullanabileceği API ürünleri. Bunları entegre veya Drupal tabanlı geliştirici portallarına ekleyebilirsiniz. |
| Özel veya Yalnızca dahili | Özel veya şirket içi kullanım için tasarlanmış API ürünleri. Not: Gizli ve Yalnızca dahili erişim düzeyleri arasında işlevsel bir fark yoktur. API ürününün hedef kitlesini en iyi tanımlayan etiketi seçin. Entegre portal için gizli veya yalnızca dahili API ürünleri ekleyebilir ve gerektiğinde bunları uygulama geliştiricilerin kullanımına sunabilirsiniz. Drupal tabanlı geliştirici portalları için geliştirici portalınızda Gizli veya Yalnızca dahili API ürünlerine erişimi aşağıdaki bölümlerde açıklandığı şekilde yönetebilirsiniz:
|