Credenciais de acesso
Escolha como a plataforma se autentica perante o seu sistema e guarde a chave, o token ou o usuário de forma criptografada.
Nesta página
As credenciais permitem que a plataforma se conecte à API do seu sistema, por exemplo para testar a conexão com o botão Testar. Elas são armazenadas criptografadas e nunca são mostradas novamente: depois de salvá-las, você só verá uma pista com os últimos caracteres.
Não confunda essas credenciais com o Segredo de assinatura do webhook: as credenciais servem para a plataforma entrar no seu sistema; o segredo serve para o seu sistema assinar o que envia à plataforma.
Antes de começar
Você precisa do papel Administrador.
Peça ao responsável pelo sistema uma credencial somente de leitura, se o sistema permitir. A plataforma não precisa de permissões de escrita.
Tipos de autenticação
Em Autenticação, dentro do formulário da integração, escolha uma opção. Cada uma mostra seus próprios campos:
Opção | Campos |
|---|---|
Sem autenticação | Nenhum |
API key | API key e Nome do header (opcional), por exemplo |
Token Bearer | Token |
Usuário e senha | Usuário e Senha |
OAuth 2.0 (client credentials) | Client ID, Client secret e URL do token |
Abaixo dos campos você verá: São armazenadas criptografadas e não são mostradas novamente; você só verá uma pista dos últimos caracteres.
Se em API key você deixar vazio Nome do header (opcional), a chave é enviada no header X-API-Key.
Com OAuth 2.0 (client credentials), a plataforma guarda os dados criptografados, mas por enquanto Testar consulta o seu sistema sem se autenticar. Se o seu sistema exigir autenticação na rota de saúde, o teste responderá com um código como 401.
Salvar as credenciais ao criar
Em Configurações → Integrações, clique em Nova integração.
Escolha o tipo em Autenticação e preencha os campos.
Preencha o restante do formulário e clique em Salvar.
Trocar ou manter as credenciais ao editar
No cartão da integração, clique no botão Editar (lápis).
Abaixo de Autenticação você verá Credencial salva: com a pista e Deixe os campos em branco para mantê-la. Os campos aparecem vazios com o texto Deixar em branco para manter.
Faça uma destas coisas:
Mantê-la: deixe os campos em branco.
Substituí-la: escreva a nova credencial nos campos.
Mudar de tipo: escolha outro tipo em Autenticação. Você verá Você mudou o tipo de autenticação: informe as novas credenciais. Preencha os campos do novo tipo: o formulário não exige isso, mas se você deixá-los vazios fica salva a credencial anterior, que não serve para o novo tipo.
Apagá-la: escolha Sem autenticação. Você verá Ao salvar, a credencial salva é apagada.
Clique em Salvar.
Ao mudar o tipo de autenticação, o que você tinha escrito nos campos é descartado. Se errar o tipo, escolha o correto novamente e escreva de novo.
Ninguém pode ver uma credencial depois de salvá-la, nem mesmo um administrador. Se você a perder, gere uma nova no seu sistema e substitua-a aqui.
O que acontece depois
O cartão da integração mostra em Autenticação o tipo escolhido e a pista da credencial. Para verificar se funciona, use Testar a conexão.
Se o teste responder As credenciais salvas não podem ser descriptografadas (a chave mestra mudou). Informe-as novamente., edite a integração e escreva a credencial de novo.