Ajustes API

La página «Configuración de la API» te permite gestionar tus credenciales de la API, configurar los webhooks y controlar el funcionamiento de la SMS API. Cada clave de API tiene su propio conjunto de credenciales y configuración.

Acceder a la configuración de la API

1. Inicia sesión en tu panel de control de Vonage
2. Vaya a Ajustes → Ajustes API en la barra lateral izquierda.
3. Seleccione una clave API en la parte superior.

Una vez que hayas seleccionado una clave API,

Clave y secreto de la API

Su Clave API aparece en la parte superior de la página, en el menú desplegable de la cuenta. Se trata de un identificador público que se utiliza en las solicitudes de la API. También puedes asignarle un apodo para identificarlo en toda la plataforma (por ejemplo, «Producción», «Desarrollo», «Pruebas»).

Su Secretos de la API se muestran en el Clave API secreta sección:

• Secreto de API 1 - Su secreto de autenticación principal (enmascarado por defecto)
• API secreta 2 - Su secreto secundario para la rotación (enmascarado por defecto)

Si aún no tiene un segundo secreto de API, podrá crear uno aquí haciendo clic en el enlace "crear nuevo secreto".

Tipo de API de mensajería

Configura cómo Vonage maneja los mensajes SMS para esta clave API.

Vonage dispone de dos SMS API diferentes para enviar SMS. Solo puedes utilizar una a la vez, ya que cambia el formato de los webhooks que recibes.

Elija su API:

• SMS API - API heredada con un formato de webhook más sencillo (GET o POST)
• Messages API - API multicanal moderna con webhooks JSON

Haga clic en el botón correspondiente para seleccionar la API que desea utilizar.

SMS API

Formato del webhook

Sólo para SMS APIseleccione el formato de los webhooks de recepción de entrega (DLR):

1. Haz clic en el Formato de webhook menú desplegable.
2. Elige entre:
   • GET - Datos de webhook enviados como parámetros de consulta URL
   • PUBLICAR - Los datos del webhook se envían como cuerpo codificado por formulario
   • POST-JSON - Datos del webhook enviados como cuerpo JSON (recomendado)

Webhooks de recibos de entrega (DLR)

Reciba actualizaciones del estado de entrega de los mensajes SMS salientes.

1. En el Webhooks de recibos de entrega (DLR) introduzca la URL de su webhook.
2. Ejemplo: https://example.com/webhooks/delivery-receipt
3. Cuando se envía un SMS (o el envío falla), Vonage envía una notificación a esta URL.

Para obtener más información sobre la carga útil de los webhooks, consulte la página Referencia sobre los webhooks de la SMS API.

Webhooks de SMS entrantes

Recibe notificaciones cuando alguien envíe un SMS a tu número de Vonage.

1. En el Webhooks de SMS entrantes introduzca la URL de su webhook.
2. Ejemplo: https://example.com/webhooks/inbound-sms
3. Cuando alguien envía un mensaje de texto a tu número de Vonage, el mensaje se reenvía a esta URL.

Para obtener más información sobre la carga útil de los webhooks, consulte la página Referencia sobre mensajes entrantes de la SMS API.

Messages API

Webhooks de estado

Recibe notificaciones sobre el estado de los mensajes enviados.

1. En el Webhooks de estado introduzca la URL de su webhook.
2. Ejemplo: https://example.com/webhooks/status-updates
3. Cuando cambia el estado de un mensaje que has enviado, Vonage envía una actualización a esta URL.

Para obtener más información sobre la carga útil de los webhooks, consulte la página Referencia sobre los webhooks de la Messages API.

Webhooks entrantes

Recibe notificaciones cuando un cliente te envíe un mensaje.

1. En el Webhooks entrantes introduzca la URL de su webhook.
2. Ejemplo: https://example.com/webhooks/inbound-message
3. Cuando alguien te envía un mensaje a través de cualquiera de tus canales de la Messages API, el mensaje se reenvía a esta URL.

Para obtener más información sobre la carga útil de los webhooks, consulte la página Referencia de mensajes entrantes de la API de Messages.

Webhooks firmados

Agrega una capa opcional de seguridad para verificar que las solicitudes de webhook provengan de Vonage y no hayan sido manipuladas durante el tránsito.

Secreto de firma

Clave secreta utilizada para generar la firma incluida en las solicitudes de webhook.

1. En el Webhooks firmados consulte su Secreto de firma (enmascarado por defecto).
2. Haz clic en el icono de ojo para revelar el secreto.
3. Haz clic en el icono de copia para copiarlo en el portapapeles.

Método de firma

Elige el algoritmo utilizado para crear la firma del webhook:

1. Haz clic en el Método de firma menú desplegable.
2. Elige entre:
   • Firma HASH MD5 (legado, no recomendado)
   • Firma HMAC-MD5
   • Firma SHA1 HMAC
   • Firma SHA-256 HMAC (recomendado)
   • Firma SHA-512 HMAC (más seguro)

Cuando se activa, las solicitudes entrantes de webhook incluyen un token JWT en el encabezado de autorización, que se firma con su secreto de firma. Más información sobre validación de webhooks firmados.

Conformidad

Cifras de la HIPAA

Si su Account ha sido habilitada para adquirir Numbers conformes con la HIPAA, verá el siguiente aviso:

Comunícate con tu administrador de cuentas de Vonage si necesitas habilitar el cumplimiento de la HIPAA para tu caso de uso.