Usando a API de Criação de Site do Cato com o Postman

Este artigo explica como usar o cliente API Postman e executar as APIs do Cato para provisionar sites no aplicativo de gerenciamento do Cato.

Visão geral da Configuração do Postman

Este é um resumo de alto nível da configuração do Postman para executar a API de configuração do Cato para provisionar e atualizar locais.

Gerar a chave de API do aplicativo de gerenciamento do Cato.
Baixe e importe a Coleção e o Ambiente do Postman.
Configure o Ambiente.
Execute a API e provisione sites na conta.

Gerando a Chave de API do Aplicativo de Gerenciamento do Cato

A chave de API é um código que o cliente API usa para autenticar com sua conta do Cato. Você pode usar a tela de Gerenciamento de API no Aplicativo de Gerenciamento do Cato para gerar uma chave de API com permissões de Edição.

Para gerar uma chave de API para a API de Criação do Cato:

No menu de navegação, clique em Recursos > Chaves de API.
Na guia Chaves de API, clique em Novo. O painel Criar Chave de API é aberto.
Insira o Nome da Chave.
Defina a Permissão de API para Editar.
Recomendamos definir uma data para a chave de API Expirar em.
Clique em Aplicar. A chave de API é adicionada e uma janela popup contendo a nova chave de API é exibida.
Clique em (Copiar) e copie a Chave de API gerada pelo Aplicativo de Gerenciamento do Cato e salve-a em um local seguro.

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

Adicionando a Coleção e o Ambiente da API do Cato ao Postman

Criamos uma Coleção e um Ambiente customizados do Postman para ajudar você a começar a provisionar sites com a API de Criação do Cato. Esses arquivos customizados estão disponíveis no repositório Cato.

_cato_env_template_.postman_environment.json
Arquivos de API de Mutação para a API de configuração (como Cato Site Mutation API v1.postman_collection.json)

O Ambiente do Postman contém variáveis (URL da API, ID da Conta CMA, etc.) e a Coleção do Postman contém exemplos de chamadas da API de Mutação GraphQL. Para importá-los, clique em "Importar", solte o arquivo na janela e clique em importar:

Para adicionar a Coleção e o Ambiente da API do Cato ao Postman:

Baixe a Coleção e Ambientes customizados deste artigo da KB para o seu dispositivo.
No Postman, selecione Arquivo > Importar. A janela pop-up Importar é aberta.
Clique em Fazer Upload de Arquivos e, em seguida, selecione os arquivos que você baixou no passo 1.
Clique em Importar.

O Ambiente customizado agora é mostrado no Ambientes do Postman:

A Coleção customizada agora é mostrada no Coleções do Postman:

Configurando o Ambiente do Postman

Recomendamos que você use um Ambiente separado do Postman para cada Locatário Cato onde você armazena o ID da Conta CMA e a Chave de API.

Para criar um novo ambiente do Postman:

Na guia Ambiente, clique com o botão direito no template _cat_env_template_ e selecione Duplicar.
Clique com o botão direito na cópia do Ambiente, selecione Renomear e então renomeie o Ambiente para o nome do seu locatário Cato.
Copie a Chave de API e o ID da Conta CMA e cole-os no Valor Atual dos campos relevantes no Ambiente e clique em Salvar.

Você pode recuperar o ID da conta CMA diretamente da URL:

Executando a Chamada de API do Cato para Provisão de Sites

Depois de definir a Chave de API e o ID da conta CMA para o Postman

Para executar a chamada da API e provisionar sites:

Na guia Coleções.
No canto superior direito, selecione o Ambiente que você criou na etapa anterior.
Na guia Coleções, expanda Cato Mutation API v1 > addSocketSite > _query e selecione query_stateCode.
Clique em Enviar para executar a chamada da API. O resultado esperado é 200 OK e alguns dados.