API local de la Plataforma de WhatsApp Business

Inicio de sesión

/v1/users/login

Para autenticarte con el cliente de la API de WhatsApp Business, debes iniciar sesión. Para ello, envía tu nombre de usuario y contraseña a través de la autenticación básica. Recibirás un identificador de portador como respuesta. A continuación, usa el identificador de portador para la autenticación al enviar solicitudes a cualquier extremo 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, secret. Esta cuenta no se puede eliminar del sistema. Por motivos de seguridad, debes cambiar la contraseña de administrador al iniciar sesión por primera vez.

Recomendaciones de contraseña

Es recomendable que utilices contraseñas seguras al crear cuentas nuevas y al establecer contraseñas para estas, de acuerdo con las prácticas recomendadas del sector.

Las contraseñas deben tener entre 8 y 64 caracteres de longitud y contener como mínimo:

  • 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 se aplica al crear una cuenta nueva o al cambiar la contraseña de una cuenta existente.

Creación

Para autenticarte, debes usar la autenticación básica (nombre de usuario y contraseña) al iniciar sesión. El parámetro Authorization se establece en el encabezado HTTP. El valor de type es Basic y el valor de credentials es una cadena codificada mediante Base64 que incluye los campos username y password unidos mediante dos puntos (es decir, username:password).

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

  • Si el proceso se realiza correctamente, se genera el identificador. La respuesta contiene el identificador en el campo token.
  • Si no se realiza correctamente, se devuelve un error.

Ejemplos

Primer inicio de sesión

Por motivos de seguridad, debes actualizar la contraseña de administrador predeterminada con una nueva mediante el campo new_password la primera vez que intentas iniciar sesión. Si intentas iniciar sesión con la contraseña predeterminada y sin información del campo new_password, el sistema devuelve un error.

Puedes consultar nuestras recomendaciones en la sección sobre contraseñas. El primer inicio de sesión debería tener el aspecto siguiente:

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

La versión cURL tiene el aspecto siguiente:

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 estándar

El inicio de sesión estándar del cliente de la API de WhatsApp Business tiene el aspecto siguiente:

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

La versión cURL tiene el aspecto siguiente:

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 se realiza correctamente, se devuelve el estado 200 OK junto con el identificador y su fecha de caducidad. Todos los identificadores generados caducan en un plazo de 7 días. La respuesta tiene el aspecto del ejemplo siguiente:

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

Si la solicitud no se realiza correctamente, ves el estado HTTP 401 Unauthorized. Este error suele indicar que el nombre de usuario o la contraseña que se han enviado con la solicitud de inicio de sesión no son válidos y, por tanto, que el cliente de la API de WhatsApp Business no puede generar el identificador.

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

Campos devueltos

Campo Descripción

token

Obligatorio.

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

expires_after

Obligatorio.

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

Más información