API local de la Plataforma de WhatsApp Business

WhatsApp Business Platform > On-Premises API > Reference

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.

Configuración

/v1/settings

Utiliza el nodo settings para configurar el cliente de la API de WhatsApp Business, tu perfil de empresa, tu perfil, los grupos y tu cuenta, así como para la copia de seguridad y la restauración de datos. Entre las opciones configurables se incluyen: la configuración de la aplicación, la configuración del perfil, la configuración del perfil de empresa, la copia de seguridad y la restauración y la verificación en dos pasos.

Perímetros

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

Perímetro	Descripción
`/application`	Se usa para actualizar, recuperar o restablecer la configuración de la aplicación del cliente de la API de WhatsApp Business.
`/profile`	Se usa para actualizar o recuperar la configuración del perfil.
`/business/profile`	Se usa para definir las siguientes opciones de configuración del perfil de empresa: dirección de la empresa, descripción de la empresa, correo electrónico del contacto de la empresa, sector de la empresa y sitio web de la empresa.
`/business/compliance_info`	Se usa para proporcionar y recuperar la información de cumplimiento del comercio electrónico de una empresa.
`/backup` y `/restore`	Se usan para realizar una copia de seguridad y restaurar la información, incluidos el registro y la configuración de la aplicación.
`/account/two-step`	Usa la verificación en dos pasos para añadir un nivel de seguridad adicional al cliente de la API de WhatsApp Business.

Antes de empezar

Debes usar la cuenta admin para acceder a las opciones de configuración.

Llamadas a la API

Llamada	Acción	Devuelve
`PATCH /v1/settings/application`	Actualizar varias opciones de configuración de la aplicación.	Ningún objeto `application` (carga útil).
`GET /v1/settings/application`	Obtener todas las opciones de configuración de la aplicación.	Un objeto `application` que contiene el nombre y el valor de todas las opciones configurables de la aplicación.
`DELETE /v1/settings/application`	Restablecer todas las opciones de configuración de la aplicación.	Ningún objeto `application` (carga útil).
`POST /v1/settings/business/profile`	Actualizar el perfil de empresa.	Ningún objeto `profile` de empresa (carga útil).
`GET /v1/settings/business/profile`	Obtener la configuración del perfil de empresa.	Objeto `profile` de empresa que contiene la dirección, la descripción, el correo electrónico, el sector y los sitios web.
`PATCH /v1/settings/profile/about`	Actualizar el texto del perfil de empresa (información).	Ningún objeto `about` de perfil (carga útil).
`GET /v1/settings/profile/about`	Obtener texto del parámetro `about` del perfil.	Objeto `about` del perfil que incluye el contenido de texto del perfil: Información.
`POST /v1/settings/profile/photo`	Actualizar la foto de perfil.	Ningún objeto de carga útil.
`GET /v1/settings/profile/photo`	Obtener la foto de perfil.	Contenido de imagen binaria.
`POST /v1/settings/account/two-step`	Activar la verificación en dos pasos.	Ningún objeto de carga útil.
`DELETE /v1/settings/account/two-step`	Desactivar la verificación en dos pasos.	Ningún objeto de carga útil.
`POST /v1/settings/backup`	Exportar los datos o realizar una copia de seguridad.	Un objeto `settings` que contiene datos (`data`) de copia de seguridad cifrados.
`POST /v1/settings/restore`	Importar o restaurar datos.	Ningún objeto de carga útil.
`GET /v1/settings/business/compliance_info`	Recuperar la información de cumplimiento del comercio electrónico de una empresa.	Ningún objeto de carga útil.
`POST /v1/settings/business/compliance_info`	Proporcionar la información de cumplimiento del comercio electrónico de una empresa.	Objeto `legal_entity_details`.