API local de la Plataforma de WhatsApp Business

Estamos retirando la API local. Consulta nuestro documento Retirada de la API local para obtener más información y aprender a migrar a nuestra API de nube de nueva generación.

Usuarios

/v1/users

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

Antes de empezar

El cliente de la API local de WhatsApp Business tiene una cuenta predeterminada con admin definido como el nombre de usuario con una contraseña de secret. Esta cuenta no se puede eliminar del sistema. Por motivos de seguridad, debes cambiar la contraseña de administrador inmediatamente.

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

Limitaciones

  • Solo puede crear o eliminar usuarios la cuenta admin.

Recomendaciones

  • Usa la cuenta admin únicamente para crear o eliminar usuarios.
  • Crea cuentas de usuario para administrar los clientes de la API local de WhatsApp Business.

Crear

Para crear una cuenta para un usuario de tu empresa que pueda acceder a la API de WhatsApp Business, envía el nombre de usuario y la contraseña al cliente de la API local de WhatsApp Business mediante el extremo /users. Valida el nombre de usuario y la contraseña, y crea una cuenta nueva si no existe ninguna para ese nombre de usuario. La contraseña se procesa con un hash unidireccional y se almacena en un volumen de datos. Los parámetros username y password son 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 la cuenta de usuario, recibirás un código de estado HTTP 201 Created y la carga útil siguiente:

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

Si la solicitud no es correcta, recibirás un código de estado HTTP, junto con un código de error de WhatsApp. Si envías un nombre de usuario duplicado, la respuesta del error tendrá este aspecto:

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

Parámetros

NombreDescripción

username

Obligatorio.

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

password

Obligatorio.

Debe tener entre 8 y 64 caracteres, e incluir, como mínimo, una mayúscula, una minúscula, un número y un carácter especial:


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

Authorization

Obligatorio.

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

Perímetros

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

PerímetroDescripción

/users/login

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

/users/logout

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

/users/{username}

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

Errores comunes

Código de estado HTTPMotivo

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).

Envía de nuevo la solicitud con un nombre de usuario o una contraseña que tengan la longitud adecuada.

403

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

500

La cuenta no se puede crear, 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.