Gateways de API Jitterbit

Visão geral

Quando uma API do API Manager é chamada, a conectividade com a API é habilitada através de um gateway de API. Os gateways de API lidam com as tarefas de segurança envolvidas na aceitação e processamento de chamadas feitas a uma API do API Manager.

Existem dois tipos de gateway de API:

Gateways de API na nuvem: Esses gateways são hospedados e gerenciados pela Jitterbit.
Gateways de API privados: Esses gateways são instalados, hospedados e gerenciados por você. Eles oferecem controle total sobre a autorização, roteamento, taxas e armazenamento e processamento de payload das suas APIs.

Cronograma de lançamento e notas de lançamento

O cronograma de lançamento do gateway de API varia dependendo do tipo de gateway:

O gateway de API na nuvem é atualizado automaticamente seguindo o cronograma de lançamento do Harmony.
Um instalador atualizado do gateway de API privado fica disponível na página Downloads ao final do lançamento do Harmony e da atualização do Sandbox Cloud Agent Group.
A imagem Docker do gateway de API privado fica disponível no Docker Hub ao final do lançamento do Production Cloud Agent Group da região América do Norte (NA).

Nas notas de lançamento do Harmony, cada tipo de gateway de API é incluído como um item de linha separado na tabela de datas de lançamento no topo de cada página de notas de lançamento. As notas de lançamento individuais são listadas sob o título Gateway de API, com qualquer aplicabilidade relevante a certos tipos de gateway incluída nas notas de lançamento.

Limites de requisição e tratamento de erros

Os gateways de API implementam limites de requisição e retornam esses códigos de erro HTTP para os seguintes erros. Limites adicionais no nível da plataforma podem se aplicar dependendo do tipo de gateway.

Código de erro HTTP	Descrição
`403 (Forbidden)`	O gateway de API rejeitou a requisição devido a permissões insuficientes ou falha de autenticação. Isso ocorre quando a requisição não possui credenciais válidas, usa uma chave de API expirada ou inválida, viola restrições de endereço IP ou tenta acessar uma API sem autorização adequada através do perfil de segurança atribuído.
`404 (Not Found)`	O endpoint da API solicitado não pôde ser encontrado. Isso geralmente ocorre quando a URL do serviço está incorreta, a API foi despublicada ou deletada, o prefixo da URL do ambiente é inválido ou há uma incompatibilidade na versão da API ou na raiz do serviço especificada na URL da requisição.
`414 (URI Too Large)`	A URL do serviço de API excede o limite de 8.000 caracteres.
`429 (Too Many Requests)`	A requisição é rejeitada devido a limitação de taxa. Isso ocorre quando a requisição excede a permissão de hits de API por minuto da organização, viola limites de taxa no nível do ambiente, excede limites de taxa do perfil de segurança ou quando a organização consumiu sua permissão mensal de hits de API.

Além dos limites acima, o gateway de API em nuvem gerenciado pela Jitterbit impõe um limite no nível da plataforma de 200 solicitações de API por minuto por organização. Solicitações que excedem esse limite podem sofrer rate-limiting pela plataforma. Esse limite se aplica coletivamente em todos os tipos de API, incluindo APIs personalizadas, APIs proxy e solicitações OData. Esse limite não se aplica a gateways de API privados, onde a taxa de transferência é determinada pela capacidade do servidor host.

Compressão de payload

APIs do API Manager suportam compressão gzip do payload de resposta. Para solicitar uma resposta comprimida, inclua o header de solicitação Accept-Encoding: gzip na chamada de API. O gateway de API retorna o payload comprimido com gzip e inclui o header de resposta Content-Encoding: gzip. Apenas compressão gzip é suportada.