API Local da Plataforma do WhatsApp Business

Login

/v1/users/login

Para fazer a sua autenticação no cliente da WhatsApp Business API, é preciso fazer login. Para isso, envie o seu nome de usuário e senha pela autenticação básica e receba um token de portador em resposta. Depois, use esse token para autenticar quando enviar solicitações a qualquer ponto de extremidade da WhatsApp Business API. Saiba mais sobre autenticação para usar a API.

Antes de começar

O cliente da WhatsApp Business API tem uma conta-padrão: o nome de usuário é admin, e a senha é secret. Não é possível remover nem excluir essa conta do sistema. Por motivos de segurança, você precisa alterar a senha do administrador na primeira vez que fizer login.

Recomendações de senha

Recomendamos usar senhas fortes ao criar novas contas e definir senhas para essas contas, seguindo as melhores práticas do setor.

As senhas precisam ter entre 8 e 64 caracteres e, no mínimo:

  • um dígito
  • um caractere maiúsculo
  • um caractere minúsculo
  • um destes caracteres especiais: !"#$%&\'()*+,-./:;<=>?@[]^_`{|}~

Quando uma nova conta é criada ou a senha de uma conta existente é alterada, a complexidade da senha é reforçada.

Criação

Faça a sua autenticação usando a autenticação básica (nome de usuário, senha) ao entrar. A Authorization é definida no cabeçalho HTTP. O type é Basic, e as credentials são uma string codificada em base64 composta de username e password unidos por dois-pontos (isto é, username:password).

Quando o cliente da WhatsApp Business API recebe a solicitação de login, ele processa as suas credenciais para validá-las.

  • Se a ação for bem-sucedida, o token será gerado. A resposta contém o token no campo token.
  • Se a ação não for bem-sucedida, ela retornará um erro.

Exemplos

Primeiro login

Por motivos de segurança, altere a senha-padrão do administrador usando o campo new_password na primeira vez que tentar entrar. Se você tentar entrar com a senha-padrão sem fornecer informações no campo new_password, o sistema retornará um erro.

Consulte a seção sobre senhas para ver as nossas recomendações. O primeiro login deve ter esta aparência:

  POST /v1/users/login
  Authorization: Basic base64(username:password)
  {
  "new_password": "new-password"
  }

A versão cURL deve ser assim:

curl -k -X POST https://your-webapp-hostname:your-webapp-port/v1/users/login \
  -w "\n%{http-code}\n" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Basic base64(username:password)' \
  -d '{"new_password" : "new-password"}'

Login-padrão

O login-padrão para o cliente da WhatsApp Business API é semelhante a este:

POST /v1/users/login
Authorization: Basic base64(username:password)

A versão cURL deve ser assim:

curl -X POST \
  -H 'Authorization: Basic base64(username:password)' \
  -H 'Content-Type: application/json' \
  -d '{}' \
  https://your-webapp-hostname:your-webapp-port/v1/users/login

Em caso de sucesso, o status 200 OK é retornado junto com o token e o horário de expiração do token. Todos os tokens gerados expiram em 7 dias. A resposta será semelhante a este exemplo:

{
   "users": [{
      "token": "eyJhbGciOHlXVCJ9.eyJ1c2VyIjoNTIzMDE2Nn0.mEoF0COaO00Z1cANo",
      "expires_after": "2018-03-01 15:29:26+00:00"
   }]
}

Se a solicitação não for bem-sucedida, você verá um status HTTP 401 Unauthorized. Normalmente, esse erro significa que o nome de usuário ou a senha (ou ambos) enviados com a solicitação de login são inválidos. Por isso, o cliente da WhatsApp Business API não consegue gerar o token.

Se ocorrerem outros erros na resposta, consulte estas fontes para mais informações: Códigos de erro do cliente da WhatsApp Business API e Códigos de status HTTP.

Campos retornados

Campo Descrição

token

Obrigatório.

Token de autenticação a ser usado para todas as outras chamadas da WhatsApp Business API. O token deve ser enviado no cabeçalho de autenticação no formato:
Authorization: Bearer <authentication-token>

expires_after

Obrigatório.

Registro de data e hora de expiração do token. Por padrão, são 7 dias.

Saiba mais