Zasada VerificationAPIKey

Wyświetlasz dokumentację Apigee Edge.
Zapoznaj się z dokumentacją Apigee X. info

Co

Zasada Weryfikacja klucza interfejsu API umożliwia wymuszanie weryfikacji kluczy interfejsu API w czasie działania, dzięki czemu tylko aplikacje z zatwierdzonymi kluczami interfejsu API mogą uzyskiwać dostęp do Twoich interfejsów API. Zasady te zapewniają, że klucze interfejsu API są prawidłowe, nie zostały cofnięte i mają uprawnienia do korzystania z określonych zasobów powiązanych z usługami API.

Przykłady

<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 zasadach weryfikacji klucza interfejsu API

Gdy deweloper zarejestruje aplikację w Edge, Edge automatycznie wygeneruje parę klucza i klucza tajnego klienta. Parę klucza i klucza tajnego klienta aplikacji możesz wyświetlić w interfejsie Edge lub uzyskać do niej dostęp za pomocą interfejsu Edge API.

Podczas rejestracji aplikacji deweloper wybiera co najmniej 1 produkt interfejsu API, który ma być powiązany z aplikacją. Produkt interfejsu API to zbiór zasobów dostępnych za pomocą serwerów proxy interfejsu API. Następnie programista przekazuje klucz interfejsu API (klucz klienta) w ramach każdego żądania do interfejsu API w produkcie API powiązanym z aplikacją. Więcej informacji znajdziesz w artykule Omówienie publikowania.

Klucze API mogą być używane jako tokeny uwierzytelniające lub do uzyskiwania tokenów dostępu OAuth. W OAuth klucze interfejsu API są nazywane „identyfikatorami klienta”. Nazwy te można stosować zamiennie. Więcej informacji znajdziesz na stronie głównej OAuth.

Podczas wykonywania zasady Verify API Key Edge automatycznie wypełnia zestaw zmiennych przepływu. Więcej informacji znajdziesz w sekcji Zmienne przepływu poniżej.

Odniesienie do elementu

W tych zasadach możesz skonfigurować te elementy i atrybuty:

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

W tym przykładzie pokazujemy atrybuty tagu <VerifyAPIKey>:

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

W tej tabeli opisano atrybuty wspólne dla wszystkich elementów nadrzędnych zasad:

&lt;DisplayName&gt; element

Używaj oprócz atrybutu name do oznaczania zasady w edytor proxy interfejsu zarządzania z 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. Zazwyczaj klient wysyła klucz interfejsu API w parametrze zapytania, nagłówku HTTP lub parametrze formularza. Jeśli na przykład klucz jest wysyłany w nagłówku o nazwie x-apikey, będzie można go znaleźć w zmiennej: request.header.x-apikey

Atrybuty

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

Przykłady

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

Jako parametr zapytania:

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

W nagłówku 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 weryfikacji klucza interfejsu API jest egzekwowana w przypadku prawidłowego klucza interfejsu API, Edge wypełnia zestaw zmiennych przepływu. Te zmienne są dostępne dla zasad lub kodu wykonywanego później w procesie i są często używane do przeprowadzania niestandardowego przetwarzania na podstawie atrybutów klucza API, takich jak nazwa aplikacji, usługa API używana do autoryzacji klucza lub niestandardowe atrybuty klucza API.

Zasady wypełniają kilka różnych typów zmiennych przepływu, w tym:

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

Każdy typ zmiennej przepływu ma inny prefiks. Wszystkie zmienne są skalarami, z wyjątkiem tych, które są wyraźnie oznaczone jako tablice.

Ogólne zmienne przepływu

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

verifyapikey.{policy_name}

Na przykład: verifyapikey.{policy_name}.client_id

Dostępne zmienne:

Zmienne przepływu aplikacji

Zasady wypełniają te zmienne przepływu zawierające informacje o aplikacji: Wszystkie te zmienne mają prefiks:

verifyapikey.{policy_name}.app.

Na przykład:

verifyapikey.{policy_name}.app.name

Dostępne zmienne:

Zmienne przepływu dewelopera

Zasady wypełniają te zmienne przepływu zawierające informacje o deweloperze: Wszystkie te zmienne mają prefiks:

verifyapikey.{policy_name}.developer

Na przykład:

verifyapikey.{policy_name}.developer.id

Dostępne zmienne:

Zmienne przepływu firmy

Poniższe zmienne przepływu zawierające informacje o firmie są wypełniane przez zasady. Wszystkie te zmienne mają prefiks:

verifyapikey.{policy_name}.company

Na przykład:

verifyapikey.{policy_name}.company.name

Dostępne zmienne:

Zmienne Analytics

Gdy w przypadku prawidłowego klucza interfejsu API zostanie zastosowana zasada Weryfikuj klucz interfejsu API, w Analytics automatycznie wypełnią się pola tych zmiennych: Te zmienne są wypełniane tylko przez zasady Weryfikuj klucz interfejsu API i zasady OAuth.

Zmienne i wartości mogą być używane jako wymiary do tworzenia raportów Analytics, które zapewniają wgląd w wzorce wykorzystania przez deweloperów i aplikacje.

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

Odniesienie do błędu

W tej sekcji opisano kody błędów i komunikaty o błędach, które są zwracane, oraz zmienne błędów ustawiane przez Edge, gdy ta zasada wyzwala błąd. Warto o tym wiedzieć, jeśli rozwijasz reguły błędów, aby obsługi błędów. Więcej informacji znajdziesz w artykule Co musisz wiedzieć o błędach związanych z zasadami i postępowaniu z błędami

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 tę zasadę.

Zmienne błędów

Te zmienne są ustawiane po wystąpieniu błędu działania. Więcej informacji znajdziesz w artykule Podstawowe informacje 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