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ı gerektirerek API'nin güvenliğini sağlama başlıklı makaleye yönlendirildi.

Bir geliştirici, arka uç hizmetlerinize erişmek için API'lerinize istek gönderen bir uygulama oluşturur. API'lerinize erişimi kontrol etmek için geliştiricinin her istekte bir 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 genel olarak aşağıdaki görevlerle tanımlanabilir:

1. API'lerinizi paketleyen API ürünlerini Apigee Edge'de oluşturun.
2. Edge'e uygulama geliştiricileri kaydetme Yalnızca kayıtlı uygulama geliştiriciler uygulama kaydedebilir.
3. Geliştiriciler, API ürünlerine erişmek için Edge'e uygulama kaydeder. Bunun üzerine geliştirici bir API anahtarı alır. Geliştirici artık bir API anahtarına sahip olduğuna göre API'lerinize istekte bulunabilir.

Daha fazla bilgi için Yayınlamaya giriş başlıklı makaleyi inceleyin.

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

Bu eğitici için ön koşullar

Bu eğitimde, Yahoo hava durumu API'sine erişmek için API proxy'si oluşturduğunuz ilk eğitimin tamamlandığı varsayılmaktadır. İlk eğitimi henüz tamamlamadıysanız API anahtarları gerektirerek API'yi güvenli hale getirme başlıklı makaleyi inceleyin.

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

1. Yönetim kullanıcı arayüzünde Yayınla sekmesini, ardından Ürünler'i tıklayın.
2. (+) Ürün'ü tıklayın.
3. Ürün ekle iletişim kutusundaki alanlara 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 şirket içi
   Anahtar onay türü	Otomatik (API anahtarı oluşturulduktan sonra otomatik olarak onaylanır)
   Kota	1 saatte 10 istek (İstek sayısını saatte 10 ile sınırlar)
   İzin verilen OAuth kapsamları	boş bırakın

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

   

4. Kaynaklar bölümünde şunları seçin:
   • 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ü aracılığıyla weatherapikey proxy'sindeki /forecastrss kaynağına erişebilir. Bu API ürününü weatherapiproxy proxy'sindeki veya başka bir proxy'deki diğer kaynaklara erişmek için kullanmaya çalışmak yasaktır.
     
     Kaynak Yolu için joker karakterlere izin verilir. Joker karakter "/**", tüm alt URI'lerin dahil edildiğini gösterir. Bu da /forecastrss/foo/bar biçimindeki bir kaynak anlamına gelir. Joker karakter "/", yalnızca bir alt düzeydeki URI'lerin dahil edildiğini gösterir. Daha fazla bilgi için API ürünleri oluşturma başlıklı makaleyi inceleyin.
     
     Kaynak yolu açılır listesinde, belirtilen API proxy'sinde tanımlanan tüm koşullu akışların gösterildiğini unutmayın. API proxy'sinin koşullu akışı, bir kaynak yoluyla ilişkili mantığı veya işleme adımlarını tanımlar. API ürünü, bu kaynak yollarına erişimi kontrol eder.
     
5. Import Resource'u (Kaynağı İçe Aktar) tıklayın. Kaynak yolu eklenir ve weatherapikey API proxy'si Ürün için API Proxy'leri bölümüne otomatik olarak eklenir.
6. Kaydet'i tıklayın. Yeni ürününüz, Ürünler sayfasında listelenir.

Daha fazla bilgi:

• API ürünleri oluşturma

2. adım: Geliştirici kaydetme

API anahtarı oluşturmak için bir uygulama kaydedip bunu bir API ürünüyle ilişkilendirirsiniz. Ancak, uygulamanın geliştiricisini kaydetmeden uygulamayı 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 kutusunda 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ştirici listesinde görünür.

Daha fazla bilgi:

• Uygulama geliştiricileri yönetme

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 bir uygulama kaydedebilirsiniz. Uygulamanın kaydedilmesi, uygulamayla ilişkili API ürünleri için API anahtarı oluşturur. Ardından, anahtarı uygulama geliştiricilere dağıtarak API ürünlerindeki özelliklere uygulamadan erişmelerini sağlayabilirsiniz.

1. API Platformu kullanıcı arayüzünde Yayınla sekmesini, ardından Geliştirici Uygulamaları'nı tıklayın.
2. (+) Developer App'i (Geliştirici Uygulaması) tıklayın.
3. Uygulama ekle iletişim kutusunda aşağıdaki değerleri girin:
   • Görünen Ad: Weather API Key App
   • Geliştirici: Jane Tutorial (janetutorial@example.com)
   • Geri çağırma 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 Key App'i seçin. Uygulamanın ayrıntılar sayfası açılır.
7. API ürününü oluştururken Anahtar Onay Türü: Otomatik'i seçtiğiniz için API anahtarı otomatik olarak onaylanır ve hemen görüntülenebilir. (Onay Türü: Manuel'i seçtiyseniz API anahtarını onaylamak için Ücretsiz API Ürünü'nün İşlemler sütununda Onayla'yı tıklamanız gerekir.)
8. Ürünler bölümünde, Free API Product (Ücretsiz API Ürünü) girişinin yanında, oluşturulan anahtarları göstermek için Consumer Key (Tüketici Anahtarı) ve Consumer Secret (Tüketici Gizli Kodu) sütunlarında Show'u (Göster) tıklayın.
   

   Tüketici anahtarı, API anahtarının diğer adıdır ve bir uygulamanın API proxy'niz aracılığıyla tahmin kaynağına erişmek için ihtiyaç duyduğu tek anahtardır . OAuth 2.0 aracılığıyla bir API'nin güvenliğini sağlamak için Tüketici Gizli Anahtarı (Tüketici Anahtarı ile birlikte) gerekir. Örneğin, OAuth 2.0: Yeni bir API proxy'si yapılandırma başlıklı makaleye bakın.

Daha fazla bilgi:

• Uygulamaları kaydedin ve API anahtarlarını yönetin.

4. adım: API anahtarını bir istekte kullanın

VerifyAPIKey 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 Console'dan veya cURL kullanarak isteyebilirsiniz. İstek URL'si şu biçimde olmalıdır:

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

{org-name}yerine Apigee kuruluşunuzun adını ve doğru apikey değerini girin.

Yanıtta aşağıdaki içerikleri 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>

İstekten API anahtarını çıkarırsanız veya geçersiz bir anahtar değeri belirtirseniz şu biçimde 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: Sırada ne var?

API anahtarını iletmek için bir sorgu parametresi kullanarak API'ye istek gönderdiğinize göre, anahtarı üstbilgi olarak iletmek için API'yi değiştirin.