VerificationAPIKey politikası

Apigee Edge belgelerini görüntülüyorsunuz.
. Git: Apigee X belgeleri. bilgi

Ne?

API Anahtarını Doğrulama politikası, API anahtarlarının çalışma zamanında doğrulanmasını zorunlu kılarak yalnızca Onaylı API anahtarı olan uygulamaların API'lerinize erişmesini sağlayın. Bu politika, API anahtarlarının geçerli olmasını, iptal edilmemiş ve API'nizle ilişkili belirli kaynakları tüketmek için onaylanmıştır. ürünler.

Örnekler

<VerifyAPIKey name="APIKeyVerifier">
    <APIKey ref="request.queryparam.apikey" />
</VerifyAPIKey>

curl http://myorg-test.apigee.net/mocktarget?apikey=IEYRtW2cb7A5Gs54A1wKElECBL65GVls

<VerifyAPIKey name="APIKeyVerifier">
    <APIKey ref="request.header.x-apikey" />
</VerifyAPIKey>

curl "http://myorg-test.apigee.net/mocktarget" -H "x-apikey:IEYRtW2cb7A5Gs54A1wKElECBL65GVls"

<VerifyAPIKey name="APIKeyVerifier">
    <APIKey ref="requestAPIKey.key"/>
</VerifyAPIKey>

<ExtractVariables async="false" continueOnError="false" enabled="true" name="SetAPIKeyVar">
    <Source>request</Source>
    <QueryParam name="myKey">
        <Pattern ignoreCase="true">{key}</Pattern>
    </QueryParam>
    <VariablePrefix>requestAPIKey</VariablePrefix>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</ExtractVariables>

<AssignMessage async="false" continueOnError="false" enabled="true" name="accessverifyvars">
    <AssignVariable>
        <Name>devFirstName</Name>
        <Ref>verifyapikey.verify-api-key.developer.firstName</Ref>
        <Value>ErrorOnCopy</Value>
    </AssignVariable>
    <AssignVariable>
        <Name>devLastName</Name>
        <Ref>verifyapikey.verify-api-key.developer.lastName</Ref>
        <Value>ErrorOnCopy</Value>
    </AssignVariable>
    <AssignVariable>
        <Name>devEmail</Name>
        <Ref>verifyapikey.verify-api-key.developer.email</Ref>
        <Value>ErrorOnCopy</Value>
    </AssignVariable>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

verifyapikey.{policy_name}

API Anahtarını Doğrulama politikası hakkında

Bir geliştirici Edge'e uygulama kaydettiğinde Edge otomatik olarak bir tüketici anahtarı oluşturur ve gizli çift olabilir. Uygulamanın tüketici anahtarı ve gizli anahtarı çiftini Edge kullanıcı arayüzünde görebilir veya bunlara erişebilirsiniz .

Uygulama kaydı sırasında geliştirici, aşağıdakileri yapmak için bir veya daha fazla API ürünü seçer: API ürünü, kaynak koleksiyonudur. API proxy'leri aracılığıyla erişilebilir. Geliştirici daha sonra API anahtarını (tüketici anahtarı) uygulamayla ilişkilendirilen bir API ürünündeki bir API'ye yapılan her istek. Daha fazla bilgi için Yayınlama özeti bölümüne bakın.

API anahtarları, kimlik doğrulama jetonları olarak veya OAuth erişimi elde etmek için kullanılabilir. jeton. OAuth'ta API anahtarları "istemci kimliği" olarak adlandırılır. Adlar birbirlerinin yerine kullanılabilir. Daha fazla bilgi için OAuth home (OAuth ana sayfası) sayfasına göz atın.

Edge, API Anahtarını Doğrulama politikasını yürütürken bir akış değişkeni grubunu otomatik olarak doldurur. Akış bölümüne bakın değişkenleri inceleyin.

Öğe Referansı

Bu politikada yapılandırabileceğiniz öğeler ve özellikler aşağıda verilmiştir:

<VerifyAPIKey async="false" continueOnError="false" enabled="true" name="Verify-API-Key-1">
    <DisplayName>Custom label used in UI</DisplayName>
    <APIKey ref="variable_containing_api_key"/>
</VerifyAPIKey>

<VerifyAPIKey> özellikler

Aşağıdaki örnekte <VerifyAPIKey> etiketindeki özellikler gösterilmektedir:

<VerifyAPIKey async="false" continueOnError="false" enabled="true" name="Verify-API-Key-1">

Aşağıdaki tabloda tüm politika üst öğelerinde ortak olan özellikler açıklanmaktadır:

<DisplayName> öğe

Politikayı name özelliğine ek olarak farklı bir doğal dil adına sahip yönetim arayüzü proxy düzenleyicisi.

<DisplayName>Policy Display Name</DisplayName>

<APIKey> öğe

Bu öğe, API anahtarını içeren akış değişkenini belirtir. Genellikle istemci, API anahtarını gönderir sorgu parametresinde, HTTP üstbilgisinde veya form parametresinde olmalıdır. Örneğin, anahtar bir üstbilgide gönderilirse anahtar, x-apikey adlı değişkende bulunur: request.header.x-apikey

Özellikler

Aşağıdaki tabloda <APIKey> öğesinin özellikleri açıklanmaktadır

Örnekler

Bu örneklerde anahtar, parametrelerde ve x-apikey adlı bir başlıkta iletilir.

Sorgu parametresi olarak:

<VerifyAPIKey name="APIKeyVerifier">
    <APIKey ref="request.queryparam.x-apikey"/>
</VerifyAPIKey>

HTTP üst bilgisi olarak:

<VerifyAPIKey name="APIKeyVerifier">
    <APIKey ref="request.header.x-apikey"/>
</VerifyAPIKey>

HTTP form parametresi olarak:

<VerifyAPIKey name="APIKeyVerifier">
    <APIKey ref="request.formparam.x-apikey"/>
</VerifyAPIKey>

Şemalar

Akış değişkenleri

Geçerli bir API anahtarında API Anahtarını Doğrulama politikası zorunlu kılındığında Edge bir dizi akışı doldurur değişkenlerine karşılık gelir. Bu değişkenler, akışta daha sonra yürütülen politikalarda veya kodda kullanılabilir. Genellikle API anahtarının uygulama adı, anahtarını veya API anahtarının özel özelliklerini yetkilendirmek için kullanılan API ürünü.

Politika, aşağıdakiler dahil birkaç farklı akış değişkeni türünü doldurur:

• Genel
• Uygulama
• Geliştirici
• Şirket
• Analiz

Her akış değişkeni türünün farklı bir öneki vardır. Bunlar hariç tüm değişkenler skalerdir dizi olarak belirtilir.

Genel akış değişkenleri

Aşağıdaki tabloda API Anahtarını Doğrulama politikası tarafından doldurulan genel akış değişkenleri listelenmektedir. Bu değişkenlerin tümü şu şekilde öne çıkar:

verifyapikey.{policy_name}

Örneğin: verifyapikey.{policy_name}.client_id

Kullanılabilir değişkenler şunlardır:

Uygulama akışı değişkenleri

Uygulama hakkında bilgi içeren aşağıdaki akış değişkenleri politika tarafından doldurulur. Bu değişkenlerin tümü şu şekilde öne çıkar:

verifyapikey.{policy_name}.app.

Örneğin:

verifyapikey.{policy_name}.app.name

Kullanılabilir değişkenler şunlardır:

Geliştirici akışı değişkenleri

Geliştirici hakkında bilgi içeren aşağıdaki akış değişkenleri politikası. Bu değişkenlerin tümü şu şekilde öne çıkar:

verifyapikey.{policy_name}.developer

Örneğin:

verifyapikey.{policy_name}.developer.id

Kullanılabilir değişkenler şunlardır:

Şirket akışı değişkenleri

Şirket hakkında bilgi içeren aşağıdaki akış değişkenleri politikası. Bu değişkenlerin tümü şu şekilde öne çıkar:

verifyapikey.{policy_name}.company

Örneğin:

verifyapikey.{policy_name}.company.name

Kullanılabilir değişkenler şunlardır:

Analytics değişkenleri

API Anahtarını Doğrula politikası kullanıldığında aşağıdaki değişkenler Analytics'te otomatik olarak doldurulur geçerli bir API anahtarı için zorunlu kılınır. Bu değişkenler yalnızca Verify API Key (API Anahtarı Doğrula) tarafından doldurulur politikası ve OAuth politikaları.

Değişkenler ve değerler, elde edilecek faydaları ölçmek için Analytics raporları oluşturmak üzere boyut olarak kullanılabilir. geliştiriciler ve uygulamalar tarafından tüketim kalıplarına dair görünürlük sağlar.

• apiproduct.name
• developer.app.name
• client_id
• developer.id

Hata referansı

Bu bölümde, bu politika bir hatayı tetiklediğinde döndürülen hata kodları ve hata mesajlarının yanı sıra Edge tarafından ayarlanan hata değişkenleri açıklanmaktadır. Hata kuralları geliştirirken bu bilgilerin farkında olmanız önemlidir. hoşuma gitmesi için bir fırsattır. Daha fazla bilgi için Bilmeniz gerekenler Politika hataları ve Kullanım sorun.

Çalışma zamanı hataları

Bu hatalar, politika yürütüldüğünde ortaya çıkabilir.

Dağıtım hataları

Bu politikayı içeren bir proxy dağıttığınızda bu hatalar oluşabilir.

Hata değişkenleri

Bu değişkenler, çalışma zamanı hatası oluştuğunda ayarlanır. Daha fazla bilgi için Bilmeniz gerekenler hakkında daha fazla bilgi edinin.

Örnek hata yanıtları

{  
   "fault":{  
      "faultstring":"Invalid ApiKey",
      "detail":{  
         "errorcode":"oauth.v2.InvalidApiKey"
      }
   }
}

{  
   "fault":{  
      "detail":{  
         "errorcode":"keymanagement.service.DeveloperStatusNotActive"
      },
      "faultstring":"Developer Status is not Active"
   }
}

Örnek hata kuralı

<FaultRule name="FailedToResolveAPIKey">
    <Step>
        <Name>AM-FailedToResolveAPIKey</Name>
    </Step>
    <Condition>(fault.name Matches "FailedToResolveAPIKey") </Condition>
</FaultRule>

İlgili konular