Apigee Edge belgelerini görüntülüyorsunuz.
.
Git:
Apigee X belgeleri. bilgi
Aşağıdaki bölümlerde API ürünleri ve ilgili temel kavramlar hakkında bilgi verilmektedir.
API ürünü nedir?
API sağlayıcısı olarak, API'lerinizi paket olarak sunmak ve kullanıma sunmak için API ürünleri oluşturursunuz. kullanıcıların kullanımına sunar. API ürünlerini ürün grubunuz olarak düşünebilirsiniz.
API ürünleri özel olarak şunları bir araya getirir:
- API kaynakları (URI) koleksiyonu
- Hizmet planı
- İzleme veya analiz için işletmenize özel meta veriler (isteğe bağlı)
Bir API ürününde paket hâlinde sunulan API kaynakları, bir veya daha fazla API'den gelebilir. Böylece, kaynakları karıştırıp eşleştirebilirsiniz. özel özellik kümeleri oluşturmak için kaynakları kullanın.
Belirli ihtiyaçları çözen kullanım alanlarına hitap etmek için birden fazla API ürünü oluşturabilirsiniz. Örneğin, çok sayıda eşleme kaynağını Google Ads'e aktaran bir API ürünü geliştiricilerin haritaları uygulamalarına kolayca entegre etmelerini sağlar. Ayrıca, her API ürünü için farklı özellikler (ör. farklı fiyatlandırma) ayarlayabilirsiniz seviyelere dokunun. Örneğin, aşağıdaki API ürün kombinasyonlarını sunabilirsiniz:
- Uygun bir fiyatla, günde 1.000 istek gibi düşük bir erişim sınırı sunan API ürünü. Aynı kaynaklara erişim sağlayan ancak erişim sınırı ve fiyatı daha yüksek 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 denetleyebilirsiniz. Örneğin, her ay Yalnızca dahili geliştiricilerin veya yalnızca ödeme yapan müşterilerin erişebileceği kaynaklar.
API ürünleri, API'lerinize erişim ve yetkilendirme için merkezi mekanizmadır. Apigee'de API anahtarları, API'lerin kendisi 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, Uygulamaları kaydetme bölümünde açıklandığı gibi uygulamalarını kaydederek API ürünlerinize erişirler. Bir uygulama bir API ürününe erişmeye çalıştığında, aşağıdakilerin sağlandığından emin olmak için çalışma zamanında Apigee tarafından 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şmadı.
- Tanımlanmışsa API ürününde tanımlanan OAuth kapsamları, erişimle ilişkilendirilmiş kapsamlarla eşleşir. uygulama tarafından sunulan jeton.
Temel kavramları anlama
API ürünlerinizi oluşturmadan önce aşağıdaki temel kavramları inceleyin.
API anahtarları
Bir geliştiricinin uygulamasını kuruluşunuzda 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şleştirilmesi sonucunda Edge, uygulamaya benzersiz bir tüketici anahtarı atar.
Tüketici anahtarı veya erişim jetonu, istek kimlik bilgileri görevi görür. Uygulama geliştirici, tüketici anahtarını uygulamaya yerleştirir, böylece uygulama istekte bulunduğunda Edge tarafından barındırılan bir API'ye göndermek isterseniz uygulama, istekteki tüketici anahtarını aşağıdaki yöntemlerden biriyle iletir:
- API, API anahtarı doğrulamasını kullandığında, uygulama doğrudan tüketici anahtarını geçirmelidir.
- API, OAuth Jetonu doğrulamasını kullandığında uygulamanın tüketici anahtarından türetilmiş bir jeton iletmesi gerekir.
API anahtarı zorunlu kılma işlemi otomatik olarak gerçekleşmez. Tüketici anahtarının veya OAuth jetonlarının kullanılıp kullanılmadığı olarak değiştirirseniz API Proxy'si, sayfanızdaki istek kimlik bilgilerini doğrular. VerifyAPIKey politikası veya OAuth/VerifyAccessToken politikası ekleyerek API proxy'leri kullanma, takip edebilirsiniz. Web sitenize kimlik bilgisi yaptırımı politikası API Proxy'si kullanıyorsanız herhangi bir çağrı, API'lerinizi çağırabilir. Daha fazla bilgi için API Anahtarı Doğrulama politikasını inceleyin.
Edge, istekte iletilen kimlik bilgilerini doğrulamak için aşağıdaki adımları gerçekleştirir:
- İstekle birlikte iletilen kimlik bilgilerini alın. OAuth durumunda Jeton doğrulamasının ardından Edge, jetonun süresinin sona ermediğini doğrular ve ardından tüketiciyi arar. anahtarının değerini belirleyebilirsiniz.
- Tüketici anahtarının ilişkilendirildiği API ürünlerinin listesini alın.
- Mevcut API Proxy'sinin API Ürününe dahil olduğunu ve geçerli API'nin kaynak yolu (URL yolu), API Ürünü'nde etkinleştirilmiştir.
- Tüketici anahtarının süresinin dolmadığından veya iptal edilmediğini, uygulamanın iptal edilmediğinden emin olun. ve uygulama geliştiricinin etkin olup olmadığını kontrol edin.
Yukarıdaki denetimlerin hepsi geçerse kimlik bilgisi doğrulaması başarılı olur.
Sonuç olarak Edge otomatik olarak tüketici anahtarları oluşturur ancak API yayıncıları, Uygun politikaları kullanarak API proxy'lerinde anahtar kontrolünü zorunlu kılma.
Otomatik ve manuel onay
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ırın. Bu durumda, API ürünü. Daha fazla bilgi için Uygulamaları kaydetme ve API'yi yönetme tuşlar.
Kotalar
Kotalar, arka uç sunucularınızı yüksek trafik için koruyabilir ve ürün serinizi farklılaştırabilir. Örneğin, kotası yüksek olan kaynakları premium ürün olarak paket hâline getirmek ve daha düşük bir kotaya sahip paketle aynı paketi satın alabilir. Kota, sunucularınızın bir ürünün popüler olması ve çok fazla talep alması durumunda bunaltıcı olabilir.
Kotanın yapılandırılması hakkında bilgi edinmek için Kota politikası başlıklı makaleyi inceleyin. Şu konular hakkında daha fazla bilgi için: kota politikalarında ürün kota ayarlarını kullanarak aşağıdaki topluluk makalesini inceleyin Bir API ürünündeki kota ayarları, API proxy'sindeki kota politikalarıyla nasıl etkileşimde bulunur?
OAuth kapsamları
Ek bir güvenlik düzeyi olarak, OAuth kapsamlarını virgülle ayrılmış liste şeklinde tanımlayabilirsiniz. Bu bilgiler, ürün aracılığıyla gönderilen erişim jetonlarında bulunmalıdır. Ürün oluştururken kurumunuzun 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ı makaleye göz atın.
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 kurum içi | Özel veya şirket içi kullanım için tasarlanmış API ürünleri. Not: Gizli ve 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 bunları gerektiğinde uygulama geliştiricilerin kullanımına sunabilirsiniz. Drupal tabanlı geliştirici portallarında, geliştirici portalınızdan gizli veya dahili API ürünlerine erişimi aşağıdaki bölümlerde açıklandığı şekilde yönetebilirsiniz:
|