Para que serve as chaves de API e quem pode acessa-las?

Modificado em Qui, 11 Dez, 2025 na (o) 2:59 PM

Para que serve a chave de API e quem pode acessá-la?

Objetivo

Este artigo explica a finalidade da chave de API dentro da plataforma Abbiamo e esclarece quem está autorizado a acessá-la.

A chave de API é fundamental para viabilizar a integração entre os sistemas dos embarcadores (como ERPs) e a API da Abbiamo, garantindo autenticação e segurança nas requisições.

Com essa chave, os sistemas dos embarcadores podem realizar operações automaticamente na plataforma, como:

Criar e atualizar pedidos;
Cadastrar filiais;
Consultar o status de entregas;
Realizar cotações de frete;
Entre outras operações disponibilizadas pela API.

Quem pode acessar a chave de API?

O acesso à chave de API deve ser restrito, preferencialmente, aos seguintes perfis:

Usuários com permissão de administrador técnico ou equivalente;
Times de tecnologia / integrações do embarcador, responsáveis pelos ERPs e demais sistemas integrados.

Como visualizar a chave de API

Siga o passo a passo abaixo para visualizar a chave de API na plataforma Abbiamo.

Acesse a plataforma Abbiamo com um usuário que tenha permissão para gerenciar ajustes/configurações.
Na tela de pedidos (ou em qualquer tela principal da plataforma), vá até o canto inferior esquerdo e clique no ícone de engrenagem (⚙️) para abrir o menu Ajustes.

Dentro de Ajustes, no menu lateral esquerdo, localize a seção Desenvolvedor e clique em API.
Na tela API, em Chave de API, você poderá:
- Visualizar a chave (clicando no ícone de “olho”);
- Copiar a chave para a área de transferência (clicando no ícone de “copiar”).

⚠️ Atenção: a chave de API é sensível e deve ser compartilhada apenas com os times técnicos autorizados do embarcador. Evite enviá-la em canais inseguros ou públicos.

Boas práticas e considerações

A chave de API é de uso exclusivo dos times técnicos dos embarcadores, responsáveis pelos ERPs, integrações e demais recursos tecnológicos.
Uma mesma chave pode ser utilizada em várias integrações, desde que sejam respeitados os limites de segurança e as boas práticas de desenvolvimento adotadas pelo embarcador.
Em caso de suspeita de que a chave foi exposta ou comprometida, recomenda-se:
- Revogar ou substituir a chave de API o quanto antes (quando disponível);
- Atualizar todas as integrações para utilizar a nova chave;
- Se necessário, entrar em contato com o time de suporte da Abbiamo.