Zasada VerificationAPIKey

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Co

Zasady weryfikacji klucza interfejsu API umożliwiają egzekwowanie weryfikacji kluczy interfejsu API w czasie działania, dzięki czemu dostęp do interfejsów API mają tylko aplikacje z zatwierdzonymi kluczami interfejsu API. Ta zasada zapewnia, że klucze interfejsu API są prawidłowe, nie zostały unieważnione i zatwierdzone pod kątem wykorzystywania określonych zasobów powiązanych z usługami interfejsu API.

Sample

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

Informacje o zasadzie weryfikacji klucza interfejsu API

Gdy deweloper rejestruje aplikację na Edge, Edge automatycznie generuje parę klucza klienta i obiektu tajnego. Para klucza klienta i obiektu tajnego możesz zobaczyć w interfejsie użytkownika Edge lub uzyskać do nich dostęp za pomocą interfejsu Edge API.

W momencie rejestracji aplikacji deweloper wybiera co najmniej jedną usługę interfejsu API, która zostanie powiązana z aplikacją. Usługa API jest zbiorem zasobów dostępnych przez serwery proxy interfejsu API. Następnie deweloper przekazuje klucz interfejsu API (klucz klienta) w ramach każdego żądania wysyłanego do interfejsu API w usłudze API powiązanej z aplikacją. Więcej informacji znajdziesz w artykule Omówienie publikowania.

Klucze interfejsu API można wykorzystać jako tokeny uwierzytelniania lub uzyskać tokeny dostępu OAuth. W protokole OAuth klucze interfejsu API są określane jako „identyfikator klienta”. Nazwy mogą być używane zamiennie. Więcej informacji znajdziesz w artykule Strona główna protokołu OAuth.

Edge automatycznie wypełnia zestaw zmiennych przepływu podczas wykonywania zasady weryfikacji klucza interfejsu API. Więcej informacji znajdziesz poniżej w sekcji Zmienne przepływu.

Odniesienie do elementu

Oto elementy i atrybuty, które możesz konfigurować w tej zasadzie:

<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>

Atrybuty <VerifyAPIKey>

Ten przykład pokazuje atrybuty w tagu <VerifyAPIKey>:

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

Tabela poniżej zawiera opis atrybutów wspólnych dla wszystkich elementów nadrzędnych zasad:

Element <DisplayName>

Użyj oprócz atrybutu name, aby oznaczyć zasadę w edytorze serwera proxy interfejsu zarządzania inną nazwą w języku naturalnym.

<DisplayName>Policy Display Name</DisplayName>

Element <APIKey>

Ten element określa zmienną przepływu, która zawiera klucz interfejsu API. Zwykle klient wysyła klucz interfejsu API w parametrze zapytania, nagłówku HTTP lub parametrze formularza. Jeśli np. klucz jest wysyłany w nagłówku o nazwie x-apikey, klucz znajdzie się w zmiennej: request.header.x-apikey

Atrybuty

W tabeli poniżej opisujemy atrybuty elementu <APIKey>.

Przykłady

W tych przykładach klucz jest przekazywany w parametrach i nagłówku x-apikey.

Jako parametr zapytania:

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

Jako nagłówek HTTP:

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

Jako parametr formularza HTTP:

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

Schematy

Zmienne przepływu

Gdy zasada Weryfikacja klucza interfejsu API jest egzekwowana dla prawidłowego klucza interfejsu API, Edge wypełnia zestaw zmiennych przepływu. Te zmienne są dostępne dla zasad lub kodu uruchamianego na późniejszym etapie procesu i często są wykorzystywane do niestandardowego przetwarzania na podstawie atrybutów klucza interfejsu API, takich jak nazwa aplikacji, usługa API używana do autoryzacji klucza lub niestandardowe atrybuty klucza interfejsu API.

Zasada wypełnia kilka różnych typów zmiennych przepływu, w tym:

• Ogólne
• Promująca aplikację
• Deweloper
• Firma
• Statystyki

Każdy typ zmiennej przepływu ma inny prefiks. Wszystkie zmienne są skalarami, z wyjątkiem tych oznaczonych specjalnie jako tablice.

Ogólne zmienne przepływu

W tabeli poniżej znajdziesz ogólne zmienne przepływu wypełniane przez zasadę Zweryfikuj klucz interfejsu API. Wszystkie te zmienne mają przedrostek:

verifyapikey.{policy_name}

np.: verifyapikey.{policy_name}.client_id

Dostępne zmienne to:

Zmienne przepływu aplikacji

Ta zasada uzupełnia podane niżej zmienne przepływu zawierające informacje o aplikacji. Wszystkie te zmienne mają przedrostek:

verifyapikey.{policy_name}.app.

Na przykład:

verifyapikey.{policy_name}.app.name

Dostępne zmienne to:

Zmienne przepływu dewelopera

Zasada uzupełnia podane niżej zmienne przepływu zawierające informacje o deweloperze. Wszystkie te zmienne mają przedrostek:

verifyapikey.{policy_name}.developer

Na przykład:

verifyapikey.{policy_name}.developer.id

Dostępne zmienne to:

Zmienne przepływu firmy

Ta zasada uzupełnia podane niżej zmienne przepływu zawierające informacje o firmie. Wszystkie te zmienne mają przedrostek:

verifyapikey.{policy_name}.company

Na przykład:

verifyapikey.{policy_name}.company.name

Dostępne zmienne to:

Zmienne Analytics

Gdy dla prawidłowego klucza interfejsu API egzekwowana jest zasada weryfikacji klucza interfejsu API, poniższe zmienne są automatycznie wypełniane w Analytics. Te zmienne są wypełniane tylko przez zasadę weryfikacji klucza interfejsu API i zasady OAuth.

Zmienne i wartości mogą służyć jako wymiary do tworzenia raportów Analytics, które dają wgląd we wzorce konsumpcji przez deweloperów i aplikacje.

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

Informacje o błędach

W tej sekcji opisujemy kody błędów i komunikaty o błędach, które są zwracane, oraz zmienne błędów ustawiane przez Edge, gdy ta zasada wywołuje błąd. Te informacje są ważne, jeśli opracowujesz reguły dotyczące błędów do obsługi takich błędów. Więcej informacji znajdziesz w sekcjach Co musisz wiedzieć o błędach zasad i Postępowanie w przypadku błędów.

Błędy w czasie wykonywania

Te błędy mogą wystąpić podczas wykonywania zasady.

Błędy wdrażania

Te błędy mogą wystąpić podczas wdrażania serwera proxy zawierającego te zasady.

Zmienne błędów

Te zmienne są ustawiane, gdy wystąpi błąd środowiska wykonawczego. Więcej informacji znajdziesz w artykule Co musisz wiedzieć o błędach związanych z naruszeniem zasad.

Przykładowe odpowiedzi na błędy

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

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

Przykładowa reguła błędu

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

Powiązane artykuły