API de instalaciones locales de la Plataforma de WhatsApp Business

Inicio de sesión

/v1/users/login

Debes iniciar sesión para autenticarte en el cliente de la API de WhatsApp Business. Para iniciar sesión, envía tu nombre de usuario y tu contraseña en el contexto de la autenticación básica y recibe un token del portador en la respuesta. Luego, usa el token del portador para autenticarte cuando envíes solicitudes a cualquier punto de conexión de la API de WhatsApp Business. Obtén más información sobre la autenticación para usar la API.

Antes de empezar

El cliente de la API de WhatsApp Business tiene una cuenta predeterminada; el nombre de usuario de la cuenta es admin y la contraseña es secret. Esta cuenta no puede eliminarse ni borrarse del sistema. Por razones de seguridad, es obligatorio cambiar la contraseña del administrador en el primer inicio de sesión.

Recomendaciones sobre la contraseña

Te recomendamos que uses contraseñas seguras cuando crees cuentas y definas las contraseñas de esas cuentas de acuerdo con las prácticas recomendadas del sector.

Las contraseñas deben tener entre 8 y 64 caracteres y, por lo menos, lo siguiente:

  • un dígito
  • un carácter en mayúscula
  • un carácter en minúscula
  • uno de los siguientes caracteres especiales: !"#$%&\'()*+,-./:;<=>?@[]^_`{|}~

La complejidad de la contraseña es obligatoria y se verifica cuando se crea una cuenta o cuando se cambia la contraseña de una cuenta existente.

Creación

Cuando inicias sesión, te autenticas mediante la autenticación básica (nombre de usuario y contraseña). La Authorization se define en el encabezado HTTP. El type es Basic y las credentials son una cadena codificada con base64 que consta del username y la password separados por dos puntos (es decir, username:password).

Cuando el cliente de la API de WhatsApp Business recibe la solicitud de inicio de sesión, las credenciales se procesan para su validación.

  • Si la operación se realiza correctamente, se genera el token. La respuesta contiene el token en el campo token.
  • Si la solicitud no es satisfactoria, se devuelve un mensaje de error.

Ejemplos

Primer inicio de sesión

Por razones de seguridad, deberás actualizar la contraseña de administrador predeterminada y cambiarla por una nueva usando el campo new_password la primera vez que trates de iniciar sesión. El sistema devolverá un error si tratas de iniciar sesión con la contraseña predeterminada y no completas el campo new_password.

Consulta Contraseñas para conocer nuestras recomendaciones. El primer inicio de sesión debe tener el siguiente aspecto:

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

La versión cURL tiene este aspecto:

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"}'

Inicio de sesión básico

El inicio de sesión básico para el cliente de la API de WhatsApp Business tiene este aspecto:

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

La versión cURL tiene este aspecto:

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

Si la solicitud es satisfactoria, se devuelve un estado 200 OK, junto con el token y su tiempo de validez. Todos los tokens generados caducan en siete días. La respuesta tiene el aspecto del siguiente ejemplo:

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

Si la solicitud no es correcta, verás un estado HTTP 401 Unauthorized. En general, este error indica que el nombre de usuario y/o la contraseña enviados con la solicitud de inicio de sesión no son válidos, por lo que el cliente de la API de WhatsApp Business no puede generar el token.

Si hay errores en la respuesta, consulta las siguientes fuentes para obtener más información: Códigos de error del cliente de WhatsApp Enterprise y Códigos de estado de HTTP.

Campos devueltos

Campo Descripción

token

Obligatorio.

Token de autenticación que se usa para todas las demás llamadas a la API de WhatsApp Business. El token debe enviarse en el encabezado de la autorización con el siguiente formato:
Authorization: Bearer <authentication-token>

expires_after

Obligatorio.

Marca de tiempo de caducidad del token. El valor predeterminado es de 7 días.

Más información