Gerando Chaves de API para a API da Cato

Este artigo explica como gerar uma chave API para a API de leitura e para a API de mutação da Cato.

Visão Geral das Chaves de API da Cato

A página de Chaves de API permite que você gere chaves API no Aplicativo de Gerenciamento Cato, que são usadas para autenticar no servidor API da Cato. Digite a chave API para um cliente API (como Postman ou Altair) ou para scripts que executem chamadas API para autenticar na Cato.

Cato suporta dois tipos de chamadas API:

Visualizar permissões - Execute chamadas API de leitura para recuperar dados da sua conta
Editar permissões - Execute chamadas API de escrita para fazer alterações em sua conta

Certifique-se de copiar a chave API da janela pop-up. Uma vez que você feche a janela pop-up, não poderá acessar a chave novamente.

Nota

Nota: Se você estiver usando a API eventsFeed para ingerir dados de eventos, certifique-se de selecionar Habilitar integração com eventos da Cato na página Recursos > Integração de Eventos.

Adicionando Chaves de API a um Cliente de API

Para autenticar solicitações na API Cato, inclua um cabeçalho HTTP chamado x-api-key no seu cliente de API. Defina o valor deste cabeçalho para a sua chave de API Cato usando o formato: x-api-key: <api-key>. Por exemplo: x-api-key: abcdef12345. Este cabeçalho autoriza sua solicitação e concede acesso aos endpoints relevantes da API Cato com base nas permissões associadas à sua chave.

Gerenciamento de Chaves de API

A página de Chaves de API mostra as chaves API da sua conta. Você pode usar esta tela para gerar e revogar chaves API. O Nome da chave API é usado apenas para identificar cada chave e não é usado como parte do processo de autenticação.

Gerando uma Chave API

Gere a chave para a API da Cato e, em seguida, cole-a no cliente API ou script.

Para gerar uma chave API:

No menu de navegação, clique em Recursos > Chaves de API.
Clique em Novo. O painel Criar Chave API será aberto.
Digite um Nome da Chave.
Selecione a Permissão da API para esta chave.
(Opcional) Selecione uma data em que a chave API Expira.

Para chaves API com permissões de Editar, recomendamos definir uma data em que a chave API Expira.
(Opcional) Para segurança adicional, em Permitir acesso de IPs, selecione Lista de IPs específicos, e defina os endereços IP permitidos para usar esta chave API.

A configuração padrão é permitir esta chave API para Qualquer IP.
Clique em Aplicar. A chave API é adicionada e uma janela pop-up contendo a nova chave API é exibida.
Clique em (Copiar) e copie a Chave gerada pelo Aplicativo de Gerenciamento Cato e salve-a em um local seguro.

Uma vez que você feche esta janela, não poderá acessar o valor da chave API.
Clique em OK para fechar a janela pop-up.

Revogando uma Chave API

Você pode revogar a chave API e removê-la do Aplicativo de Gerenciamento Cato. Uma vez revogada, a chave não poderá ser usada para autenticar no servidor API.

Para revogar uma chave API:

No menu de navegação, clique em Conta > Chaves de API.
Na linha com a chave API, clique em (Deletar).
Na janela de confirmação, clique em Deletar. A chave API é revogada e removida da sua conta.