2. Bölüm: API anahtarı oluşturma ve test etme

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi

Yeniden düzenlendi ve API anahtarları zorunlu kılarak API'nin güvenliğini sağlama hedefine yönlendirildi.

Geliştirici, arka uç hizmetlerinize erişmek için API'lerinize istek gönderen bir uygulama derler. API'lerinize erişimi kontrol etmek için geliştiricinin her istekte API anahtarı iletmesini zorunlu kılabilirsiniz. Anahtar eksik veya geçersizse istek başarısız olur.

Yayınlama, API'lerinizi uygulama geliştiricilerin kullanımına sunma sürecidir. Yayınlama API'leri aşağıdaki görevlerle geniş kapsamlı olarak tanımlanabilir:

  1. Apigee Edge'de API'lerinizi paketleyen API ürünlerini oluşturun.
  2. Edge'de uygulama geliştiricilerini kaydedin. Yalnızca kayıtlı bir uygulama geliştirici bir uygulamayı kaydedebilir.
  3. Geliştiriciler, API ürünlerine erişmek için uygulamaları Edge'e kaydeder. Buna karşılık, geliştirici bir API anahtarı alır. Geliştiriciler artık bir API anahtarına sahip olduklarına göre API'lerinize istek gönderebilirler.

Daha fazla bilgi için Yayınlamaya giriş konusuna bakın.

Aşağıdaki tabloda, uygulamaları kaydetmek ve anahtar oluşturmak için kullanılan bazı terimler tanımlanmıştır:

Terim Tanım
API ürünü Bir API proxy'si paketi ve bu API'lere erişim sınırlarını belirleyen hizmet planı. API ürünleri, Apigee Edge'in API'lerinize yetkilendirme ve erişim kontrolü için kullandığı merkezi mekanizmadır.
Developer API tüketicisi. Geliştiriciler API'lerinize istek gönderen uygulamalar yazar.
Uygulama Bir geliştiricinin API ürününe erişmek için kaydettiği istemci tarafı uygulama. Uygulamanın API ürününe kaydedilmesi, bu üründeki API'lere erişmek için kullanılacak API anahtarı oluşturur.
API anahtarı İstemci taraflı bir uygulamanın, API ürünü tarafından sunulan kaynaklara erişmek için kullandığı yetkilendirme bilgilerini içeren bir dize. API anahtarı, kayıtlı bir uygulama bir API ürünüyle ilişkilendirildiğinde oluşturulur.

Bu eğitimin ön koşulları

Bu eğitim, Yahoo Hava Durumu API'sine erişmek için bir API proxy'si oluşturduğunuz ilk eğitimi tamamladığınız varsayılır. İlk eğiticiyi henüz tamamlamadıysanız API anahtarları zorunlu kılarak API'nin güvenliğini sağlama başlıklı makaleyi inceleyin.

1. Adım: Bir API ürünü oluşturun

  1. Yönetim kullanıcı arayüzünde Yayınla sekmesini ve ardından Ürünler'i tıklayın.
  2. (+) Ürün'ü tıklayın.
  3. Ürün Ekle iletişim kutusu alanlarında aşağıdakileri girin veya seçin:
    Alan Değer
    Ad Ücretsiz API Ürünü
    Görünen Ad Ücretsiz API Ürünü
    Açıklama Ücretsiz API Ürünü
    Ortam test
    Erişim Yalnızca dahili
    Anahtar onay türü Otomatik
    (API anahtarı, oluşturulduktan sonra otomatik olarak onaylanır)
    Kota 1 saatte 10 istek
    (istek sayısını saatte 10 olarak sınırlar)
    İzin Verilen OAuth Kapsamları boş bırakın

    Doldurulan iletişim kutusu şu şekilde görünmelidir:

  4. Kaynaklar bölümünde:
    • API Proxy'si: weatherapikey
    • Düzeltme: 1
    • Kaynak Yolu: /forecastrss**

      Kaynak Yolu, ürünün bir uygulamanın erişmesine izin verdiği kaynak URI'lerini belirtir. Bu örnekte, bir uygulama yalnızca bu API ürünü üzerinden weatherapikey proxy'sindeki /forecastrss kaynağına erişebilir. Bu API ürününü weatherapiproxy proxy'sindeki veya başka bir proxy'deki başka bir kaynağa erişmek için kullanmak yasaktır.

      Kaynak Yolu'nda joker karakterlere izin verilir. "/**" joker karakteri, tüm alt URI'ların dahil edildiğini belirtir. Bu da /forecastrss/foo/bar biçiminde bir kaynak anlamına gelir. "/" joker karakteri, yalnızca bir düzey alttaki URI'lerin dahil edildiğini belirtir. Daha fazla bilgi için API ürünleri oluşturma bölümüne bakın.

      Kaynak Yolu açılır listesinin, belirtilen API proxy'sinde tanımlanan tüm koşullu akışları gösterdiğini unutmayın. API proxy'sinin koşullu akışı, kaynak yoluyla ilişkilendirilmiş mantığı veya işleme adımlarını tanımlar. Bir API ürünü, bu kaynak yollarına erişimi kontrol eder.
  5. Kaynağı İçe Aktar'ı tıklayın. Kaynak yolu ve weatherapikey API proxy'si, otomatik olarak Ürün İçin API Proxy'leri bölümüne eklenir.
  6. Kaydet'i tıklayın. Yeni ürününüz Ürünler sayfasında listelenir.

Daha fazla bilgi:

2. Adım: Bir geliştirici kaydedin

API anahtarı oluşturmak için bir uygulamayı kaydedip bir API ürünüyle ilişkilendirirsiniz. Ancak bir uygulamayı daha önce uygulamanın geliştiricisine kaydettirmeden kaydedemezsiniz.

  1. Yönetim kullanıcı arayüzünde Yayınla sekmesini ve ardından Geliştiriciler'i tıklayın.
  2. (+) Geliştirici'yi tıklayın.
  3. Yeni Geliştirici iletişim kutusuna aşağıdaki değerleri girin:
    • Ad: Jane
    • Soyadı: Eğitim
    • E-posta adresi: janetutorial@example.com
    • Kullanıcı adı: jtutorial
  4. Kaydet'i tıklayın. Yeni geliştirici, Geliştiriciler sayfasındaki geliştiriciler listesinde görünür.

Daha fazla bilgi:

3. Adım: Uygulamayı kaydedin

Artık bir API ürününüz ve bir geliştiriciniz olduğuna göre API ürününe uygulama kaydedebilirsiniz. Uygulamanın kaydedilmesi, uygulamayla ilişkili API ürünleri için API anahtarı oluşturur. Daha sonra anahtarı uygulama geliştiricilere dağıtabilir, böylece API ürünlerindeki özelliklere uygulamadan erişebilirler.

  1. API Platformu kullanıcı arayüzünde Yayınla sekmesini ve ardından Geliştirici Uygulamaları'nı tıklayın.
  2. (+) Geliştirici Uygulaması'nı tıklayın.
  3. Uygulama Ekle iletişim kutusuna aşağıdaki değerleri girin:
    • Görünen Ad: Weather API Anahtar Uygulaması
    • Geliştirici: Jane Tutorial (janetutorial@example.com)
    • Callback URL (Geri arama URL'si): Boş bırakın
  4. Uygulamayı bir ürünle ilişkilendirin:
    1. Ürünler bölümünde + Ürün'ü tıklayın.
    2. Ücretsiz API Ürünü'nü seçin.
    3. Değişiklikleri kabul etmek için onay işareti simgesini tıklayın.
  5. Kaydet'i tıklayın. Yeni uygulama, Geliştirici Uygulamaları sayfasındaki uygulamalar listesinde görünür.
  6. Uygulama listesinden Weather API Anahtar Uygulaması'nı seçin. Uygulamanın ayrıntılar sayfası açılır.
  7. API ürününü oluştururken Anahtar Onay Türü: Otomatik seçeneğini belirlediğiniz için API anahtarı otomatik olarak onaylanır ve hemen görüntüleyebilirsiniz. (Onay Türü: Manuel seçeneğini işaretlediyseniz API anahtarını onaylamak için Ücretsiz API Ürünü'nün İşlemler sütununda Onayla'yı tıklamanız gerekirdi.)
  8. Ürünler bölümünde, Ücretsiz API Ürünü girişinin yanında, oluşturulan anahtarları görüntülemek için Tüketici Anahtarı ve Tüketici Sırrı sütunlarında Göster'i tıklayın.

    Tüketici Anahtarı, API anahtarının başka bir adıdır ve uygulamaların API proxy'niz üzerinden öngörme kaynağına erişmesi için gereken tek anahtardır . OAuth 2.0 aracılığıyla API'nin güvenliğini sağlamak için Tüketici Anahtarı ile birlikte Tüketici Sırrı gereklidir. Örneğin, OAuth 2.0: Yeni bir API proxy'si yapılandırma bölümüne bakın.

Daha fazla bilgi:

4. Adım: Bir istekte API anahtarını kullanın

VerificationAPIKey politikasının doğru çalıştığından emin olmak için geçerli bir API anahtarıyla API proxy'sine çağrı yaparak politikayı test etmeniz gerekir. API proxy'sini bir tarayıcıda, API proxy'sinin İzleme sayfasından, Apigee Konsolu'ndan veya cURL kullanarak isteyebilirsiniz. İstenecek URL şu biçimdedir:

http://{org-name}-test.apigee.net/v1/weatherapikey/forecastrss?w=12797282&apikey=IEYRtW2cb7A5Gs54A1wKElECBL65GVls

Apigee kuruluş adınızı {org-name} ve doğru apikey değeriyle değiştirin.

Yanıtta aşağıdaki içeriği arayın:

<rss xmlns:yweather="http://xml.weather.yahoo.com/ns/rss/1.0" xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" version="2.0"> 
<channel> <title>Yahoo! Weather - Palo Alto, CA</title> 
<link>http://us.rd.yahoo.com/dailynews/rss/weather/Palo_Alto__CA/*http://weather.yahoo.com/forecast/USCA1093_f.html</link> 
<description>Yahoo! Weather for Palo Alto, CA</description> <language>en-us</language>

API anahtarını istekten çıkarır veya geçersiz bir anahtar değeri belirtirseniz şu şekilde bir hata yanıtı alırsınız:

{"fault":{"faultstring":"Failed to resolve API Key variable null","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

5. Adım: Sonraki adım ne?

API anahtarını iletmek için sorgu parametresi kullanarak API'ye istekte bulunduğunuza göre API'yi, anahtarı başlık olarak iletecek şekilde değiştirin.

API anahtarlarını zorunlu kılarak API'nin güvenliğini sağlama bölümüne geçin.