API de instalaciones locales de la Plataforma de WhatsApp Business

WhatsApp Business Platform > On-Premises API > Reference

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.

Configuración

/v1/settings

Usa el nodo settings para configurar el cliente de la API de WhatsApp Business, tu perfil de empresa, tu perfil personal, los grupos y tu cuenta, y para realizar una copia de seguridad de los datos y restaurarlos. Configuraciones ajustables: configuración de apps, configuración de perfiles, configuración de perfiles empresariales, copia de seguridad y restauración, y verificación de dos pasos.

Perímetros

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

Perímetro	Descripción
`/application`	Se usa para actualizar, recuperar o restablecer la configuración de la app del cliente de la API de WhatsApp Business.
`/profile`	Se usa para actualizar o recuperar la configuración de tu perfil.
`/business/profile`	Se usa para configurar las siguientes opciones del perfil de empresa: dirección de la empresa, descripción de la empresa, correo electrónico del contacto de la empresa, sector y sitio web de la empresa.
`/business/compliance_info`	Se usa para proporcionar y recuperar información de cumplimiento de comercio electrónico de una empresa.
`/backup` y `/restore`	Úsalos para copias de seguridad y restauraciones de información que incluya configuraciones y registros en apps.
`/account/two-step`	Usa la verificación en dos pasos para agregar un nivel de seguridad adicional al cliente de la API de WhatsApp Business.

Antes de empezar

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

Llamadas a la API

Llamada	Uso	Resultado
`PATCH /v1/settings/application`	Actualiza múltiples ajustes de configuración de la aplicación.	Ningún objeto de `application` (carga).
`GET /v1/settings/application`	Obtiene toda la configuración de la aplicación.	Un objeto de `application` que contiene el nombre y el valor de todos los ajustes de la aplicación que se pueden configurar.
`DELETE /v1/settings/application`	Restablece todos los ajustes de la aplicación.	Ningún objeto de `application` (carga).
`POST /v1/settings/business/profile`	Actualiza el perfil de empresa.	Ningún objeto de `profile` (carga) de la empresa.
`GET /v1/settings/business/profile`	Obtiene la configuración del perfil de empresa.	Objeto `profile` de la empresa con la dirección, la descripción, el correo electrónico, el sector y los sitios web.
`PATCH /v1/settings/profile/about`	Actualiza el texto del perfil de empresa (información).	Ningún objeto `about` (carga) de perfil.
`GET /v1/settings/profile/about`	Obtiene texto del parámetro `about` del perfil.	Objeto `about` del perfil con contenido de texto para la información del perfil.
`POST /v1/settings/profile/photo`	Actualiza la foto del perfil.	Ningún objeto de carga.
`GET /v1/settings/profile/photo`	Obtiene la foto del perfil.	Contenido de imagen binaria.
`POST /v1/settings/account/two-step`	Activa la verificación en dos pasos.	Ningún objeto de carga.
`DELETE /v1/settings/account/two-step`	Desactiva la verificación en dos pasos.	Ningún objeto de carga.
`POST /v1/settings/backup`	Exporta los datos o realiza una copia de seguridad.	Un objeto `settings` con el valor `data` cifrado para la copia de seguridad.
`POST /v1/settings/restore`	Importa o restaura datos.	Ningún objeto de carga.
`GET /v1/settings/business/compliance_info`	Recupera la información de cumplimiento de comercio electrónico de una empresa.	Ningún objeto de carga.
`POST /v1/settings/business/compliance_info`	Proporciona información de cumplimiento de comercio electrónico de una empresa.	Un objeto de `legal_entity_details`.