Como gerenciar suas chaves de API com segurança no Octadesk?

O que é o gerenciamento de chaves de API?

O Octadesk permite armazenar as chaves de API de sistemas terceiros — como seu ERP, sua plataforma de e-commerce ou de pagamento — de forma centralizada e criptografada. Em vez de colar a chave diretamente em cada componente ou tarefa automatizada, você cadastra a chave uma única vez e apenas a seleciona onde precisar. O cadastro fica em Configurações > Geral > API > Tokens externos.

Por que usar?

Quando a chave de API é colada diretamente em um componente, ela fica visível em texto para qualquer usuário com acesso àquele fluxo — o que abre risco de cópia indevida e de acesso não autorizado ao seu sistema.

Com o cadastro centralizado, a chave fica criptografada e o valor dela não é exibido nem mesmo após o cadastro. Apenas administradores gerenciam as chaves; quem monta o fluxo seleciona a chave pelo nome, sem nunca visualizar o valor.

Como cadastrar uma chave?

1. Acesse Configurações > Geral > API > Tokens externos. Esse menu é visível apenas para administradores.

2. Clique em adicionar e dê um nome que identifique o sistema (ex.: "API VTEX") e uma descrição.

3. Cole a chave de API gerada no sistema terceiro e salve. Após salvar, o valor da chave não é mais exibido.

Como usar a chave em uma integração?

Ao configurar uma tarefa automatizada ou um componente "Conecte a outro sistema", selecione a chave cadastrada no campo de credenciais — em vez de colar o valor manualmente. O comportamento da integração é o mesmo; a diferença é que a credencial fica protegida.

Compatibilidade

O componente de integração suporta APIs no padrão REST com corpo em JSON. APIs no padrão SOAP não são suportadas.

Quem tem acesso?

Apenas administradores visualizam o menu de Configurações de API e as chaves cadastradas. Usuários de outros grupos utilizam as integrações normalmente, sem acesso às chaves.

Qual a diferença para os Tokens de API Octadesk?

Os Tokens de API Octadesk são gerados pelo Octadesk para que outros sistemas consumam a API do Octa (por exemplo, em ferramentas de automação externas). O gerenciamento de chaves de API faz o caminho contrário: guarda chaves de sistemas terceiros para uso nas integrações dentro do Octa.