Política VerifyAPIKey

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Esta página se aplica ao Apigee e ao Apigee híbrido .

Veja a documentação do Apigee Edge .

Visão geral

A política "Verificar Chave de API" permite que você imponha a verificação de chaves de API em tempo de execução, permitindo que apenas aplicativos com chaves de API aprovadas acessem suas APIs. Essa política garante que as chaves de API sejam válidas, não tenham sido revogadas e estejam aprovadas para consumir os recursos específicos associados aos seus produtos de API.

Esta política é extensível e seu uso pode ter implicações de custo ou utilização, dependendo da sua licença da Apigee. Para obter informações sobre os tipos de política e as implicações de uso, consulte Tipos de política .

Para um tutorial mostrando como criar um proxy de API que usa a política Verificar chave de API, consulte Proteger uma API exigindo chaves de API .

Amostras

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

Sobre a política de verificação de chave de API

Quando um desenvolvedor registra um aplicativo na Apigee, a Apigee gera automaticamente um par de chaves de consumidor e segredos. Você pode ver o par de chaves de consumidor e segredos do aplicativo na interface do usuário da Apigee ou acessá-los pela API da Apigee.

No momento do registro do aplicativo, o desenvolvedor seleciona um ou mais produtos de API para associar ao aplicativo, sendo um produto de API uma coleção de recursos acessíveis por meio de proxies de API. O desenvolvedor então passa a chave de API (chave do consumidor) como parte de cada solicitação para uma API em um produto de API associado ao aplicativo. Consulte Visão geral da publicação para obter mais informações.

Chaves de API podem ser usadas como tokens de autenticação ou para obter tokens de acesso OAuth. No OAuth, as chaves de API são chamadas de "ID do cliente". Os nomes podem ser usados ​​indistintamente. Consulte a página inicial do OAuth para mais informações.

A Apigee preenche automaticamente um conjunto de variáveis ​​de fluxo ao executar a política "Verificar Chave de API". Consulte "Variáveis ​​de fluxo" abaixo para obter mais informações.

Referência de Elemento

A seguir estão os elementos e atributos que você pode configurar nesta política:

<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"/>
    <CacheExpiryInSeconds ref="request.queryparam.cache_expiry">Default value</CacheExpiryInSeconds/>
</VerifyAPIKey>

Atributos <VerifyAPIKey>

O exemplo a seguir mostra os atributos na tag <VerifyAPIKey> :

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

A tabela a seguir descreve atributos que são comuns a todos os elementos pai da política:

Elemento <DisplayName>

Use em adição ao atributo name para rotular a política no editor de proxy da interface de gerenciamento com um nome diferente em linguagem natural.

<DisplayName>Policy Display Name</DisplayName>

Elemento <APIKey>

Este elemento especifica a variável de fluxo que contém a chave de API. Normalmente, o cliente envia a chave de API em um parâmetro de consulta, cabeçalho HTTP ou parâmetro de formulário. Por exemplo, se a chave for enviada em um cabeçalho chamado x-apikey , ela será encontrada na variável: request.header.x-apikey

Atributos

A tabela a seguir descreve os atributos do elemento <APIKey>

Exemplos

Nestes exemplos, a chave é passada em parâmetros e um cabeçalho chamado x-apikey .

Como parâmetro de consulta:

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

Como um cabeçalho HTTP:

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

Como um parâmetro de formulário HTTP:

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

Elemento <CacheExpiryInSeconds>

Este elemento impõe o TTL no cache, o que permite a personalização do período de expiração do token de acesso armazenado em cache. O intervalo suportado é entre 1 e 180 segundos. Você pode fornecer uma variável de fluxo e uma variável padrão. Se fornecida, o valor da variável de fluxo tem precedência sobre o valor padrão especificado.

<CacheExpiryInSeconds ref="request.queryparam.cache_expiry">Value 1</CacheExpiryInSeconds>

Atributos

A tabela a seguir descreve os atributos do elemento <CacheExpiryInSeconds>

Esquemas

Variáveis ​​de fluxo

Quando uma política de Verificação de Chave de API é aplicada a uma chave de API válida, a Apigee preenche um conjunto de variáveis ​​de fluxo. Essas variáveis ​​ficam disponíveis para políticas ou códigos executados posteriormente no fluxo e costumam ser usadas para realizar processamento personalizado com base em atributos da chave de API, como o nome do aplicativo, o produto da API usado para autorizar a chave ou atributos personalizados da chave de API.

A política preenche vários tipos diferentes de variáveis ​​de fluxo, incluindo:

• Em geral
• Aplicativo
• Desenvolvedor
• Análise
• Monetização

Cada tipo de variável de fluxo possui um prefixo diferente. Todas as variáveis ​​são escalares, exceto aquelas especificamente indicadas como matrizes.

Variáveis ​​de fluxo geral

A tabela a seguir lista as variáveis ​​de fluxo gerais preenchidas pela política Verificar Chave de API. Todas essas variáveis ​​são prefixadas por:

verifyapikey.{policy_name}

Por exemplo: verifyapikey.{policy_name}.client_id

As variáveis ​​disponíveis incluem:

Variáveis ​​de fluxo do aplicativo

As seguintes variáveis ​​de fluxo contendo informações sobre o aplicativo são preenchidas pela política. Todas essas variáveis ​​são prefixadas por:

verifyapikey.{policy_name}.app .

Por exemplo:

verifyapikey.{policy_name}.app.name

As variáveis ​​disponíveis incluem:

Variáveis ​​de fluxo do AppGroup

As seguintes variáveis ​​de fluxo contendo informações sobre os AppGroups são preenchidas pela política. Esses atributos do AppGroup são preenchidos somente se verifyapikey.{policy_name}.app.appType for "AppGroup".

Todas essas variáveis ​​são prefixadas por:

verifyapikey.{policy_name}.appgroup .

Por exemplo:

verifyapikey.{policy_name}.appgroup.name

As variáveis ​​disponíveis incluem:

Variáveis ​​de fluxo do desenvolvedor

As seguintes variáveis ​​de fluxo contendo informações sobre o desenvolvedor são preenchidas pela política. Todas essas variáveis ​​são prefixadas por:

verifyapikey.{policy_name}.developer

Por exemplo:

verifyapikey.{policy_name}.developer.id

As variáveis ​​disponíveis incluem:

Erros de implantação

Esses erros podem ocorrer quando você implanta um proxy contendo esta política.

Variáveis ​​de falha

Essas variáveis ​​são definidas quando ocorre um erro de tempo de execução. Para obter mais informações, consulte O que você precisa saber sobre erros de política .

Respostas de erro de exemplo

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

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

Exemplo de regra de falha

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