API de instalaciones locales de la Plataforma de WhatsApp Business

La API de instalaciones locales dejará de estar disponible. Consulta nuestro documento Fin de la API de instalaciones locales para conocer los detalles y descubrir cómo migrar a nuestra nueva generación de API de la nube.

Usuarios

/v1/users

Usa el nodo users para administrar la autenticación y acceder al cliente de la API de instalaciones locales de WhatsApp Business.

Antes de empezar

El cliente de la API de instalaciones locales de WhatsApp Business tiene una cuenta predeterminada con admin configurado como el nombre de usuario y cuya contraseña es secret. Esta cuenta no se puede eliminar ni borrar del sistema. Por razones de seguridad, es obligatorio cambiar de inmediato la contraseña del administrador.

Si olvidas la contraseña, ponte en contacto con la asistencia directa para restablecerla.

Limitaciones

  • Solo la cuenta admin puede crear o eliminar usuarios.

Recomendaciones

  • Usa la cuenta admin solo para crear o eliminar usuarios.
  • Crea cuentas de usuario para administrar los clientes de la API de instalaciones locales de WhatsApp Business.

Creación

A fin de crear una cuenta para que un usuario dentro de tu empresa pueda acceder a la API de WhatsApp Business, envía el nombre de usuario y la contraseña al cliente de la API de instalaciones locales de WhatsApp Business con el punto de conexión /users. El cliente valida el nombre de usuario y la contraseña y crea una cuenta, si no hay ninguna creada para ese nombre de usuario. La contraseña se procesa con un hash unidireccional y se almacena en un volumen de datos. Tanto username como password son parámetros obligatorios.

Ejemplo

Para crear un usuario, envía una solicitud como la siguiente:

POST /v1/users
Authorization: Bearer your-auth-token

{
  "username": "username",
  "password": "password"
}

Si la solicitud es correcta y se crea una cuenta de usuario, recibirás un código de estado HTTP 201 Created y la siguiente carga:

{
  "users": [{
     "username": "username"
  }]
}

Si la solicitud no es correcta, recibirás un código de estado HTTP y un código de error de WhatsApp. Si envías un nombre de usuario duplicado, la respuesta con el error tiene el siguiente aspecto:

{
  "errors": [{
    "code": 1014,
    "title": "Internal error",
    "details": "Unable to create user. Already exist?"
  }]
}

Parámetros

NombreDescripción

username

Obligatorio.

Debe tener 4 caracteres como mínimo y 32 como máximo.
Define una plantilla para username, como la primera inicial y el apellido, para evitar crear varias cuentas para una misma persona.

password

Obligatorio.

Debe tener entre 8 y 64 caracteres, y, como mínimo, uno de ellos debe estar en mayúscula, uno en minúscula, uno debe ser un dígito y uno un carácter especial:


!\/'"#$%&()*+-.,:;_<>=?@[]{}^`|~

Authorization

Obligatorio.

Token de autenticación para el administrador que ejecuta la solicitud. Consulta la documentación Inicio de sesión y autenticación: tokens para obtener más información.

Perímetros

Los siguientes perímetros están conectados a este nodo:

PerímetroDescripción

/users/login

Usa este perímetro para iniciar sesión en el cliente de instalaciones locales de la API de WhatsApp Business.

/users/logout

Usa este perímetro para cerrar sesión en el cliente de instalaciones locales de la API de WhatsApp Business.

/users/{username}

Usa este perímetro para recuperar, actualizar o eliminar una cuenta de usuario.

Errores comunes

Código de estado HTTPRazón

400

  • La contraseña es demasiado corta (menos de 8 caracteres) o demasiado larga (más de 64 caracteres).
  • El nombre de usuario es demasiado corto (menos de 4 caracteres) o demasiado largo (más de 32 caracteres).

Vuelve a enviar la solicitud con un nombre de usuario/contraseña con la longitud adecuada.

403

No estás usando la cuenta admin para crear la cuenta de usuario.

500

No es posible crear la cuenta, posiblemente porque ya existe.

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