Ajustes API

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

Configuración de la API de acceso

1. Ingresa a tu panel 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 haya 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 Account. Se trata de un identificador público que se utiliza en las solicitudes de API. También puede darle un apodo para identificarla en toda la plataforma (por ejemplo, "Producción", "Desarrollo", "Pruebas").

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

• API secreta 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 tiene dos API diferentes para enviar SMS. Solo puedes usar una a la vez porque 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 Webhook

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

1. Haga clic en el botón Formato de webhook desplegable.
2. Elige entre:
   • GET - Datos de webhook enviados como parámetros de consulta URL
   • POST - Los datos del webhook se envían como cuerpo codificado por formulario
   • POST-JSON - Los datos del webhook se envían 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 entrega (o falla) un SMS, 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 de 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 de mensajes entrantes de la SMS API.

Messages API

Webhooks de estado

Reciba actualizaciones de estado de los mensajes salientes.

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 de los Webhooks de la API de Messages.

Webhooks de entrada

Reciba notificaciones cuando un cliente le envíe un mensaje.

1. En el Ganchos web entrantes introduzca la URL de su webhook.
2. Ejemplo: https://example.com/webhooks/inbound-message
3. Cuando alguien le envía un mensaje a través de cualquiera de sus canales de 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. Haga clic en el botón icono de ojo para revelar el secreto.
3. Haga clic en el botón icono de copia para copiarlo en el portapapeles.

Método de firma

Elige el algoritmo utilizado para crear la firma del webhook:

1. Haga clic en el botón Método de firma desplegable.
2. Elige entre:
   • Firma MD5 HASH (legado, no recomendado)
   • Firma MD5 HMAC
   • 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

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