Central de ajudaIntegrações

Para: Administradores

Criar uma chave de API

Crie uma chave de gerenciamento para a API do Painel de Administração ou uma chave central para a API do portal, limite-a aos seus endereços IP e copie-a apenas uma vez.

Neste artigo8 seções

Uma chave de APIChave Um token secreto, criado em Integração, que permite que seu próprio software use a API do hub. permite que seu próprio software, como um sistema de gerenciamento de casos, funcione em conjunto com o seu hub. A chave de gerenciamento utiliza a API do painel administrativo, para lidar com casos e pessoas; a chave do hub utiliza a API do portal, para lidar com as tarefas dentro dos casos. Entenda o que a API pode fazer.

  1. Chaves abertas

    Vá para Integração › Chaves e selecione NOVO.

  2. Dê um nome a isso.

    Abaixo de Descrição, indique o que será usado com ele, como, por exemplo, o mecanismo de sincronização Case.

  3. Limitar onde é utilizado

    Abaixo de Fonte CIDR, digite o endereço IPv4 público do qual seu sistema faz chamadas, como 203.0.113.10, ou um intervalo de endereços, como 203.0.113.0/24. As chamadas provenientes de qualquer outro lugar serão rejeitadas. O hub reconhece apenas endereços IPv4; portanto, endereços IPv6 são rejeitados.

    Se você ainda não sabe o endereço, deixe a caixa vazia. Isso permitirá que seja indicado qualquer endereço. Após o primeiro chamado do seu sistema, Último IP usado mostrará o endereço correspondente. Veja Restringir ou revogar uma chave de API.

  4. Escolha o tipo

    Abaixo de Domínio, selecione Manage para a API do Painel de Administração, ou Hub para a API do portal. Essa escolha não pode ser alterada posteriormente.

  5. Ligue-o e adicione-o.

    Ativo começa a funcionar. Deixe-o ativo: uma chave inativa será rejeitada em cada chamada. Escolha Adicionar chave. “Chave adicionada” será exibida.

  6. Copie a chave

    A janela Chave secreta exibe a chave apenas uma vez. Selecione o botão “Copiar”, Copiar para a área de transferência, e armazene a chave em um lugar onde o desenvolvedor possa acessá-la com segurança, como em um gerenciador de senhas. Depois, selecione Feito.

O que acontece a seguir?

As funcionalidades principais são enviadas de uma vez por tudo, e não expiram com o tempo. O desenvolvedor envia essas funcionalidades a cada chamada que você faz. Veja mais detalhes aqui. Autentique as solicitações da API com uma chave específica.. Ele funciona como um centro de controle para o seu hub. Assistente VirtualAssistente Virtual Um membro de equipe automatizado que publica mensagens de boas-vindas, atualizações e posts de apresentação para a empresa; suas publicações exibem um selo de Assistente Virtual., O que ele posta parece ser informações relacionadas ao Assistente Virtual.

Último uso e Último IP usado exibem a data e o endereço da última chamada realizada. Para desativá-la ou excluí-la, consulte Restringir ou revogar uma chave de API.

Se algo der errado

  • O limite principal foi atingido. O seu hub pode ter duas chaves de cada tipo. Apague uma das chaves que você não utiliza mais.
  • A fonte CIDR indica que “o bloco de endereços é inválido”. Exemplos válidos são: 203.0.113.10 ou 203.0.113.0/24. Verifique o endereço: quatro números entre 0 e 255, separados por pontos. Para indicar um intervalo de valores, use uma barra e um número que não exceda 32.
  • A fonte CIDR indica que “é necessário usar um endereço IPv4 ou um intervalo de endereços IPv4, como 203.0.113.10. A API pode ser acessada apenas por meio do protocolo IPv4.” Você digitou um endereço IPv6. Use o endereço IPv4 do seu sistema em vez disso.
  • Você perdeu a chave. Não é possível mostrar essa chave novamente. É necessário criar uma nova chave, mover o seu sistema para ela, e depois excluir a chave antiga. Se o seu hub já tiver duas chaves desse tipo, exclua primeiro a chave antiga. O seu sistema não poderá se conectar ao hub até que tenha a nova chave.

Artigos relacionados

Autenticar solicitações de API com uma chaveEnvie sua chave como um token de portador para a API do Painel de Administração para obter uma chave de gerenciamento ou para a API do portal para obter uma chave de hub, e limite-a aos seus endereços IP.IntegraçõesRestringir ou revogar uma chave de APILimite uma chave a determinados endereços IP, desative-a ou exclua-a e veja quando ela foi usada pela última vez.Integrações · 2 minEntenda o que a API pode fazer.Saiba o que uma chave de gerenciamento e uma chave central podem fazer, por que cada chave funciona como um Assistente Virtual e onde encontrar a lista completa de especificações técnicas.Integrações