VerificationAPIKey politikası

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

Ne

API Anahtarı Doğrula politikası, çalışma zamanında API anahtarlarının doğrulanmasını zorunlu kılar ve yalnızca onaylı API anahtarları olan uygulamaların API'lerinize erişmesine izin verir. Bu politika, API anahtarlarının geçerli olmasını, iptal edilmemesini ve API ürünlerinizle ilişkili belirli kaynakları tüketmesi için onaylanmasını sağlar.

Sana Özel

<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

Geliştirici, Edge'e uygulama kaydettiğinde Edge otomatik olarak tüketici anahtarı ve gizli anahtar çifti oluşturur. Uygulamanın tüketici anahtarı ve gizli anahtarı çiftini Edge kullanıcı arayüzünde görebilir veya bu öğelere Edge API'den erişebilirsiniz.

Uygulama kaydı sırasında geliştirici, uygulamayla ilişkilendirmek için bir veya daha fazla API ürünü seçer. Burada API ürünü, API proxy'leri üzerinden erişilebilen kaynaklardan oluşan bir koleksiyondur. Geliştirici, daha sonra API anahtarını (tüketici anahtarı) uygulamayla ilişkili bir API ürünündeki API'lere yapılan her isteğin parçası olarak iletir. Daha fazla bilgi için Yayınlama özeti bölümüne bakın.

API anahtarları kimlik doğrulama jetonu olarak veya OAuth erişim jetonları almak için kullanılabilir. OAuth'ta API anahtarları "istemci kimliği" olarak adlandırılır. Adlar birbirinin yerine kullanılabilir. Daha fazla bilgi için OAuth ana sayfası sayfasına göz atın.

Edge, API Anahtarını Doğrula politikasını yürütürken bir akış değişkeni grubunu otomatik olarak doldurur. Daha fazla bilgi için aşağıdaki Akış değişkenleri bölümüne bakın.

Öğ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> özellikleri

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> öğesi

Politikayı, yönetim kullanıcı arayüzü proxy düzenleyicisinde farklı bir doğal dil adıyla etiketlemek için name özelliğine ek olarak kullanın.

<DisplayName>Policy Display Name</DisplayName>

<APIKey> öğesi

Bu öğe, API anahtarını içeren akış değişkenini belirtir. Genellikle istemci API anahtarını bir sorgu parametresi, HTTP üst bilgisi veya form parametresi içinde gönderir. Örneğin, anahtar x-apikey adlı bir başlıkta gönderilirse anahtar şu 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.

Bir sorgu parametresi olarak:

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

HTTP üstbilgisi 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 bir API Anahtarını Doğrulama politikası zorunlu kılındığında, Edge bir akış değişkeni grubunu doldurur. Bu değişkenler, akışın daha sonraki aşamalarında yürütülen politikalar veya kod tarafından kullanılabilir. Bunlar genellikle API anahtarının uygulama adı, anahtarı yetkilendirmek için kullanılan API ürünü veya API anahtarının özel özellikleri gibi özelliklerine göre özel işleme gerçekleştirmek için kullanılır.

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

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

Her bir akış değişkeni türünün farklı bir ön eki vardır. Özellikle dizi olarak belirtilenler dışında tüm değişkenler skaler değerlerdir.

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üne şu ön ek eklenir:

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üne şu ön ek eklenir:

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 politika tarafından doldurulur. Bu değişkenlerin tümüne şu ön ek eklenir:

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 politika tarafından doldurulur. Bu değişkenlerin tümüne şu ön ek eklenir:

verifyapikey.{policy_name}.company

Örneğin:

verifyapikey.{policy_name}.company.name

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

Analytics değişkenleri

Geçerli bir API anahtarı için bir API Anahtarını Doğrulama politikası zorunlu kılındığında aşağıdaki değişkenler Analytics'te otomatik olarak doldurulur. Bu değişkenler yalnızca API Anahtarını Doğrulama politikası ve OAuth politikaları tarafından doldurulur.

Değişkenler ve değerler, geliştiriciler ve uygulamalar tarafından tüketilen tüketim kalıpları hakkında görünürlük sağlamak amacıyla Analytics raporları oluşturmak için boyut olarak kullanılabilir.

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

Hata referansı

Bu bölümde, bu politika bir hatayı tetiklediğinde Edge tarafından ayarlanan hata kodları ile hata mesajları ve döndürülen hata mesajları ile Edge tarafından ayarlanan hata değişkenleri açıklanmaktadır. Bu bilgiyi, hataları ele almak için hata kuralları geliştirip geliştirmediğinizi bilmeniz önemlidir. Daha fazla bilgi için Politika hataları hakkında bilmeniz gerekenler ve Hataları işleme bölümlerine bakın.

Çalışma zamanı hataları

Politika yürütüldüğünde bu hatalar ortaya çıkabilir.

Dağıtım hataları

Bu hatalar, bu politikayı içeren bir proxy dağıttığınızda ortaya çıkabilir.

Hata değişkenleri

Bu değişkenler, bir çalışma zamanı hatası oluştuğunda ayarlanır. Daha fazla bilgi için Politika hataları hakkında bilmeniz gerekenler bölümüne bakın.

Ö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"
   }
}

Hata kuralı örneği

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

İlgili konular