Политика VerifyAPIKey

Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация

Что

Политика проверки ключа API позволяет принудительно проверять ключи API во время выполнения, позволяя только приложениям с утвержденными ключами API получать доступ к вашим API. Эта политика гарантирует, что ключи API действительны, не были отозваны и одобрены для использования определенных ресурсов, связанных с вашими продуктами API.

Образцы

<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

Когда разработчик регистрирует приложение в Edge, Edge автоматически генерирует пару потребительского ключа и секрета. Вы можете увидеть пару потребительского ключа и секрета приложения в пользовательском интерфейсе Edge или получить к ним доступ через Edge API.

Во время регистрации приложения разработчик выбирает один или несколько продуктов API для связи с приложением, где продукт API представляет собой набор ресурсов , доступных через прокси-серверы API. Затем разработчик передает ключ API (ключ потребителя) как часть каждого запроса к API в продукте API, связанном с приложением. Дополнительную информацию см. в разделе Обзор публикации .

Ключи API можно использовать в качестве токенов аутентификации или для получения токенов доступа OAuth. В OAuth ключи API называются «идентификаторами клиента». Имена могут использоваться как взаимозаменяемые. Дополнительную информацию см. на главной странице OAuth .

Edge автоматически заполняет набор переменных потока при выполнении политики проверки ключа API. Дополнительную информацию см. в разделе «Переменные потока» ниже.

Ссылка на элемент

Ниже приведены элементы и атрибуты, которые можно настроить в этой политике:

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

В следующем примере показаны атрибуты тега <VerifyAPIKey> :

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

В следующей таблице описаны атрибуты, общие для всех родительских элементов политики:

Элемент <DisplayName>

Используйте в дополнение к атрибуту name , чтобы пометить политику в редакторе прокси-сервера пользовательского интерфейса управления другим именем на естественном языке.

<DisplayName>Policy Display Name</DisplayName>

Элемент <APIKey>

Этот элемент определяет переменную потока, содержащую ключ API. Обычно клиент отправляет ключ API в параметре запроса, HTTP-заголовке или параметре формы. Например, если ключ отправляется в заголовке с именем x-apikey , ключ будет найден в переменной: request.header.x-apikey

Атрибуты

В следующей таблице описаны атрибуты элемента <APIKey>

Примеры

В этих примерах ключ передается в параметрах и заголовке x-apikey .

В качестве параметра запроса:

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

В качестве HTTP-заголовка:

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

В качестве параметра формы HTTP:

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

Схемы

Переменные потока

Когда политика проверки ключа API применяется к действительному ключу API, Edge заполняет набор переменных потока. Эти переменные доступны политикам или коду, выполняемому позже в потоке, и часто используются для выполнения пользовательской обработки на основе атрибутов ключа API, таких как имя приложения, продукт API, используемый для авторизации ключа, или настраиваемые атрибуты API. ключ.

Политика заполняет несколько различных типов переменных потока, в том числе:

• Общий
• Приложение
• Разработчик
• Компания
• Аналитика

Каждый тип переменной потока имеет свой префикс. Все переменные являются скалярами, кроме тех, которые специально обозначены как массивы.

Общие переменные потока

В следующей таблице перечислены общие переменные потока, заполняемые политикой проверки ключа API. Все эти переменные имеют префикс:

verifyapikey.{policy_name}

Например: verifyapikey.{policy_name}.client_id

Доступные переменные включают в себя:

Переменные потока приложения

Следующие переменные потока, содержащие информацию о приложении, заполняются политикой. Все эти переменные имеют префикс:

verifyapikey.{policy_name}.app .

Например:

verifyapikey.{policy_name}.app.name

Доступные переменные включают в себя:

Переменные потока разработчика

Следующие переменные потока, содержащие информацию о разработчике, заполняются политикой. Все эти переменные имеют префикс:

verifyapikey.{policy_name}.developer

Например:

verifyapikey.{policy_name}.developer.id

Доступные переменные включают в себя:

Переменные потока компании

Следующие переменные потока, содержащие информацию о компании, заполняются политикой. Все эти переменные имеют префикс:

verifyapikey.{policy_name}.company

Например:

verifyapikey.{policy_name}.company.name

Доступные переменные включают в себя:

Аналитические переменные

Следующие переменные автоматически заполняются в Analytics, когда политика проверки ключа API применяется для действительного ключа API. Эти переменные заполняются только политикой проверки ключа API и политиками OAuth.

Переменные и значения можно использовать в качестве измерений для создания отчетов Analytics, чтобы получить представление о моделях потребления разработчиками и приложениями.

• apiproduct.name
• разработчик.приложение.имя
• client_id
• разработчик.id

Ссылка на ошибку

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Example error responses

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

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

Example fault rule

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

Связанные темы