Skip to main content
Uma chave de API da YCloud é uma credencial em nível de conta usada para autenticar solicitações para as APIs da YCloud. Envie-a no cabeçalho de solicitação X-API-Key a partir de sistemas confiáveis no lado do servidor. A chave de API da conta pode chamar todas as APIs disponíveis para a sua conta YCloud. Ela não se limita a um usuário individual, equipe ou número de telefone do WhatsApp Business, portanto, trate-a como um segredo altamente confidencial.
Nunca exponha uma chave de API em código de navegador ou aplicativo móvel, controle de versão, logs, capturas de tela, tíquetes ou mensagens de chat. Armazene-a em um gerenciador de segredos e conceda acesso apenas a sistemas e pessoas que precisem dela.

​
Quem pode visualizar a chave de API

Apenas membros da conta cuja função atribuída conceda acesso a Developers > API key podem abrir a página e revelar a chave. Revise as funções e permissões da conta em Users and Teams. Revelar uma chave de API requer autenticação de dois fatores (2FA). Cada usuário autorizado deve configurar a 2FA para seu próprio login na YCloud antes de poder visualizar a chave. Para configurar ou atualizar a 2FA, abra Security settings.

​
Visualizar a chave de API

  1. Faça login no painel da YCloud.
  2. Acesse Developers > API key.
  3. Localize a chave que você deseja usar.
  4. Clique no ícone de olho na coluna API key .
  5. Conclua a verificação por 2FA quando solicitado.
  6. Copie a chave e armazene-a no seu gerenciador de segredos.
A chave fica oculta por padrão. A YCloud exige 2FA sempre que um usuário autorizado precisa revelá-la.
Página de chave de API com a chave padrão mascarada e o ícone de olho indicado.

The key remains masked. Use the eye icon only when you are ready to complete verification and store the key securely.

​
Alternar uma chave de API comprometida

A YCloud dá suporte a uma chave de API em nível de conta para integrações padrão. Se você acredita que a chave foi exposta, crie uma chave de substituição e alterne seus sistemas com cuidado.
Criar uma chave de substituição não exclui nem desativa automaticamente a chave anterior. A chave antiga permanece utilizável até que você a exclua manualmente.
  1. Acesse Developers > API key.
  2. Clique em Add API Key para gerar uma substituição.
  3. Armazene a nova chave com segurança.
  4. Substitua a chave antiga em todos os serviços, ambientes e cofres de segredos usados pela sua organização.
  5. Teste as integrações afetadas com a nova chave.
  6. Depois de confirmar que todos os sistemas estão usando a nova chave, exclua manualmente a chave antiga.
Não exclua a chave antiga antes de seus sistemas terem migrado para a substituta, caso contrário, as solicitações de API que ainda a utilizam falharão.

​
Usar várias chaves com aplicativos personalizados

Se a sua organização precisa de chaves separadas para várias integrações, use custom apps. Cada aplicativo personalizado tem sua própria chave de API e permite controlar suas permissões de API, ativos do WhatsApp e configuração de Webhook. Esta é a abordagem recomendada quando as integrações precisam de credenciais separadas ou escopos de acesso diferentes.