Aegro API de Integrações

Abaixo trazemos os tópicos abordados neste artigo:

Informações importantes

Atenção

• 🔒 Dado sensível: a chave de API é a chave de autenticação e identificação, que permite acesso aos dados de sua propriedade via API, assim, é necessário que trate como uma senha.

• 🔑 Sigilo Absoluto: Nunca partilhe chaves de API por WhatsApp, e-mail, chat ou prints. Guarde a chave de autenticação num local seguro (como cofre de senhas) a partir do momento da criação, pois ela só aparece uma vez.

• 👥 Acesso Restrito: Garanta que apenas funcionários autorizados e com competência técnica mexam nas chaves de API. Use chaves de API diferentes para integrações diferentes (evite partilhar a mesma chave de API com várias pessoas ou sistemas).

• 🛡️ Princípio do Menor Privilégio: Conceda apenas as permissões estritamente necessárias para a integração. Vincule a chave de API à propriedade correta para não expor dados de outras fazendas.

• ⏳ Validade Curta: Defina o menor prazo de validade possível. Prazos curtos reduzem o risco em caso de incidentes.

• 🔍 Revisão Periódica: Acompanhe regularmente o uso das chaves de API de sua propriedade. Se uma chave de API está em desuso ou a integração foi descontinuada, revogue o chave de API imediatamente.

• 🚨 Suspeita de Vazamento? Revogue já! Na dúvida, apague a chave de API e gere um novo. A revogação é imediata e irreversível, garantindo a proteção dos seus dados.

Visão Geral

Com a API de Integrações da Aegro, ficou muito mais fácil de integrar outros sistemas e funcionalidades no Aegro. A API é uma interface de programação, através dela os parceiros podem ler e escrever informações no Aegro de forma programática.

Dessa forma, é possível realizar o desenvolvimento de novas soluções visando a expansão das funcionalidades já existentes no ecossistema Aegro e a integração com novos sistemas.

Nossa API está em constante evolução: aos poucos, estamos agregando mais possibilidades e funcionalidades a ela.

Na próxima seção desse artigo há instruções de como entrar em contato para solicitar evoluções.

As funcionalidades disponíveis podem ser consultadas na nossa documentação técnica, através do link: API de Integrações da Aegro.

Nesse link, a equipe técnica de desenvolvimento do sistema em questão pode verificar as funcionalidades disponíveis para integração, e entender melhor como utilizar a nossa API para realizar as integrações desejadas.

Como utilizar a API

Se você é um produtor que utiliza nosso sistema e gostaria de integrar o seu Aegro com outra ferramenta, você pode enviar a documentação API de Integrações da Aegro e o artigo Aegro API de Integrações para o desenvolvedor da ferramenta para que possa verificar quais dados podem ser integrados e como funciona o processo.

Se você é um desenvolvedor ou parceiro novo e gostaria de tirar alguma dúvida que não esteja coberta na nossa documentação ou propor melhorias na API, você pode entrar em contato conosco pelo email integracoes@aegro.com.br

Como acessar as informações da fazenda via API

Para que seja possível acessar aos dados da fazenda via API, é necessário uma chave de API.

Cada chave de API da acesso aos dados de uma única fazenda e pode ser configurado para ter apenas as permissões necessárias para a integração, bem com uma data de expiração.

Para gerar a(s) chave(s), o usuário com perfil Proprietário ou Gerente da propriedade, deve acessar o Aegro, clicando na inicial de seu nome e em Propriedades.

Localize a propriedade que deseja integrar e clique nos 3 pontos ao lado dela e em ↔️ API de integração

Será aberta a tela de API de integração, onde poderá criar e gerencias as chaves de API de sua propriedade.

Caso ainda não tenha nenhum chave gerada, você poderá adicionar novos ao clicar tanto em + CRIAR CHAVE DE API no canto superior direito quanto no botão CRIAR CHAVE DE API no centro da tela.

Criar nova chave de API

Ao clicar em + CRIAR CHAVE DE API ou CRIAR CHAVE DE API, será aberta uma nova janela de criação de agente de integração, onde precisará configurar informações básicas, autorizações e expiração desta chave.

Confira abaixo os campos e como preenchê-los.

Nome

Neste campo poderá preencher com um texto livre, de até 200 caracteres, que lhe auxilie a identificar a que se refere este Agente de Integração.

Indicamos que seja um nome único para que possa identificar facilmente cada chave de API em relação as permissões e sistema em utilização.

Vamos a um exemplo prático:

Se utilizarei este agente de integração para Abastecimentos via sistema Abacontrol, posso configurar o nome do agente de integração como Abastecimento - Abacontrol

Caso tenha mais de uma integração e as permissões sejam similares, indicamos utilizar um agente de integração diferente para cada sistema a ser integrado, assim tendo controle e segurança de cada integração individualmente.

Autorizações

Em conjunto com o desenvolvedor ou parceiro novo, verifique o link de Operações da API (swagger) e defina quais permissões o agente de integração terá acesso a partir da chave de API que está sendo criada.

Para selecionar as permissões, clique nas caixas de seleção ao lado de cada permissão, assinalando cada permissão desejada com um ✅ .

Caso deseje remover alguma permissão selecionada, basta clicar novamente na caixa de seleção, deixando-a vazia.

Período de validade

Neste campo você selecionará a validade deste chave, podendo ser:

• 1 dia

• 7 dias

• 30 dias

• 3 meses

• 6 meses

• 1 ano

O período sempre é contabilizado a partir do dia da criação da chave de API, assim, caso esteja criando a chave no dia 25 de maio de 2026 e informando expiração em 1 ano, a chave permanecerá válido até 25 de maio de 2027.

Finalizando a criação da chave de API

Após o preenchimento dos campos, confira as informações e permissões selecionadas com o desenvolvedor ou parceiro do sistema que realizará a integração para evitar retrabalho.

Não é possível editar uma chave de API, então confirme as permissões necessárias antes de finalizar sua criação.

Caso observe que faltaram permissões em uma chave já criada, você pode criar uma cópia a partir desta chave e adicionar as permissões faltantes, em seguida, revogando acesso da chave de API anterior.

Após a conferência dos dados, basta clicar em SALVAR para finalizar a operação e criar a chave de API.

Em seguida, o Aegro já exibirá uma tela para que possa copiar e compartilhar o chave gerada.

Clique em COPIAR CHAVE DE AUTENTICAÇÃO e compartilhe com o desenvolvedor responsável pela integração.

Também orientamos que armazene em seu computador em um local seguro, caso precise fornecer em outro momento.

A chave de autenticação da API somente é disponibilizada neste momento, garanta que a chave de autenticação esteja copiada e armazenada para controle de suas integrações.

Após armazenar corretamente, clique em ENTENDI, JÁ COPIEI para prosseguir à tela de gerenciamento de API de integração.

Criar cópia de agente de integração

Como não é possível editar um agente de integração, caso observe que faltaram permissões em uma chave de API já criada, você pode criar uma cópia a partir desta chave e adicionar as permissões faltantes, em seguida, revogando acesso da chave anterior.

Para realizar a cópia, localize a chave de API original e clique no menu Ações, disponível nos 3 pontos ao lado do mesmo e em Criar cópia.

Será aberta a janela de criação de Novo agente de integração, com os campos Autorizações e Data de expiração idênticos a chave de API original. Assim, você poderá nomear o agente e ajustar os dados conforme necessário.

Após ajustar os dados, clique em SALVAR para criar o novo agente a partir da cópia.

Revogar acesso de chave de API

Caso deseje cancelar o acesso de uma API, você pode revogar acesso à qualquer momento.

Para isto, você poderá tanto localizar o agente de integração na listagem e clicar no menu Ações, disponível nos 3 pontos ao lado do mesmo e em Revogar acesso.

Ou acessar o agente, clicando sobre ele ou no menu Ações, disponível nos 3 pontos ao lado do mesmo e em Ver detalhes, conferindo o agente configurado e, então clicar em Revogar acesso.

Em ambos caminhos, ao clicar em REVOGAR ACESSO, será gerado um aviso de confirmação da ação.

Ao revogar uma chave de API, não é possível reconsiderar e ativar novamente, sendo necessária a criação de outra chave de API e reconfiguração da integração com o responsável pela integração no sistema integrado anteriormente.

Caso deseje reconsiderar, clique em CANCELAR.

Caso deseje prosseguir com o revogação, clique em REVOGAR ACESSO.

Após revogar, o status do agente de integração é alterado para Revogado e você poderá verificá-lo pela listagem de agentes de integração.

Pronto, agora você sabe como pode realizar integrações do seu Aegro com outras plataformas.