Guias do produto

Chaves de API

Para usar a API do Wbiztool ou uma integração que peça suas credenciais, você precisa de três informações do painel:

Credencial	Campo da API	Onde encontrar
API Client ID (ID do cliente da API)	`client_id`	Configurações → Chaves API, no topo da página
Chave de API	`api_key`	Configurações → Chaves API
WhatsApp Client ID (ID do cliente WhatsApp)	`whatsapp_client`	A coluna ID do Cliente WhatsApp nas configurações do WhatsApp

Antes de começar#

Você precisa ser Administrador do espaço de trabalho para ver, criar ou excluir chaves de API. Veja Funções e permissões.
Selecione primeiro o espaço de trabalho certo. As chaves pertencem ao espaço de trabalho que está selecionado quando você as cria, e as requisições de API feitas com uma chave atuam nesse espaço de trabalho. Veja Trocar de espaço de trabalho.
Contas de demonstração não podem usar a API.

Encontrar seu API Client ID#

Abra Configurações → Chaves API. O card Visão Geral da API mostra ID do Cliente da API: seguido de um número. Use esse número como client_id em todas as requisições. Ele é o mesmo para todas as chaves do espaço de trabalho.

Criar uma chave de API#

Abra Chaves API
Acesse Configurações e clique na aba Chaves API, ou abra /settings/#api-keys diretamente.
Crie a chave
Em Nova Chave de API, clique em Criar Novo. Uma mensagem de sucesso confirma que a chave foi gerada, e ela aparece na tabela.
Copie a chave completa
A coluna Chave de API mostra só o início e o fim de cada chave. Clique no botão de copiar ao lado dela (Copiar Chave de API Completa) para copiar a chave completa e cole-a no seu app ou integração.

As chaves recebem nomes automaticamente, com base em quantas chaves o espaço de trabalho tem (API Key 1, API Key 2 e assim por diante), e não podem ser renomeadas. Depois que você exclui uma chave, uma chave nova pode receber o mesmo nome de uma já existente; por isso, diferencie as chaves pelos primeiros e últimos caracteres e pela data em Criado. As chaves não expiram: uma chave funciona até você excluí-la.

Limite#

Um espaço de trabalho pode ter até 10 chaves de API ao mesmo tempo. Quando você atinge o limite, aparece "You have reached the maximum limit of 10 API keys per organization." (você atingiu o limite máximo de 10 chaves de API por organização). Exclua uma chave que não usa mais para criar uma nova.

A tabela de chaves de API#

Coluna	Significado
Etiqueta	O nome da chave, como API Key 1.
Chave de API	Os primeiros e os últimos caracteres da chave. Use o botão de copiar para obter a chave completa.
Criado	A data em que a chave foi criada.
Status	Sempre Ativo. As chaves excluídas são removidas da tabela.
Ações	Excluir remove a chave.

Excluir uma chave de API#

Encontre a chave
Em Configurações → Chaves API, encontre a chave na tabela.
Exclua a chave
Clique em Excluir e depois em Sim, Excluir Chave de API.

A exclusão de uma chave não pode ser desfeita. Qualquer app que ainda a use para de funcionar imediatamente e recebe Auth Error: invalid api key. Atualize primeiro seus apps com uma nova chave.

IDs de cliente do WhatsApp#

Cada número de WhatsApp conectado tem o próprio ID. A maioria dos endpoints de mensagens precisa dele no campo whatsapp_client para escolher qual número envia a mensagem.

Abra as configurações do WhatsApp e veja a coluna ID do Cliente WhatsApp ao lado de cada número. Consulte Conecte seu número de WhatsApp se ainda não conectou nenhum.

Testar suas credenciais#

Chame Verificar credenciais (POST /api/v1/me/) com seu client_id e sua api_key e, opcionalmente, um whatsapp_client. Isso confirma que eles funcionam juntos, sem enviar nada nem consumir mensagens. Se o whatsapp_client não pertencer ao espaço de trabalho, a resposta é Invalid WhatsApp Client ID.

Se uma chave de API vazar#

Qualquer pessoa com sua chave de API e seu API Client ID pode enviar mensagens pelos seus números de WhatsApp e consumir as mensagens do seu espaço de trabalho.

Crie uma chave substituta
Em Configurações → Chaves API, clique em Criar Novo e copie a nova chave.
Atualize seus apps
Substitua a chave antiga em todos os apps e integrações que a usavam.
Exclua a chave vazada
Clique em Excluir na chave vazada. Ela para de funcionar imediatamente.
Verifique se houve uso indevido
Revise as mensagens recentes em Relatórios em busca de algo que você não enviou.

Trate também como sigiloso o email "WbizTool Alert - WhatsApp Connected Successfully!": ele é enviado ao criador do espaço de trabalho quando um número se conecta pela primeira vez e pode incluir uma das suas chaves de API.

Solução de problemas#

Problema	O que verificar
A aba Chaves API mostra Nenhuma Chave de API Encontrada, mas existem chaves	Você não é Administrador neste espaço de trabalho, ou outro espaço de trabalho está selecionado.
"You don't have permission to create API keys in this space." (você não tem permissão para criar chaves de API neste espaço)	Só Administradores podem criar ou excluir chaves. O botão Gerar Nova Chave de API em uma tabela vazia aparece para todos, mas só funciona para Administradores.
"You have reached the maximum limit of 10 API keys per organization."	Exclua uma chave que você não usa mais.
`Auth Error: invalid api key`	A chave foi excluída ou digitada errado, ou o `client_id` não pertence ao mesmo espaço de trabalho da chave. Se uma chave nova e o ID do Cliente da API mostrado na página ainda falharem, fale com o suporte (espaços de trabalho mais antigos podem mostrar um ID do Cliente da API que só funciona com chaves criadas pelo criador do espaço de trabalho).
`Auth Error - Please send correct API key and Client id`	A `api_key` está faltando na requisição.
`Invalid client id.` (ou `Invalid Client Id` em alguns endpoints)	O `client_id` está faltando ou não é um número. Em Verificar credenciais, um `client_id` ou `api_key` ausente retorna apenas `Auth Error`; lá, `Invalid Client Id` significa que ele não é um número. Copie-o do card Visão Geral da API.
As requisições atuam no espaço de trabalho errado	A chave foi criada em outro espaço de trabalho. Troque de espaço de trabalho e crie uma chave lá.
`Demo Account can not access apis`	Contas de demonstração não podem usar a API. Cadastre-se para ter uma conta gratuita.