- Ten en cuenta que la página de Referencia de la API actúa sobre datos en vivo, así que úsala con precaución.
- Se añadirán nuevas funcionalidades regularmente, ¡así que mantente atento a más actualizaciones!
Registro de Cambios (Changelog)
Haz clic aquí para ver el registro de cambios.
Obtención de una Clave API de Desarrollador
Una clave API de desarrollador debe incluirse como un valor en el encabezado (header) de todas las solicitudes.
Requisitos Previos
- Una cuenta de Wordly con minutos disponibles.
- Tu cuenta de Wordly debe ser añadida a una lista de permitidos (allow list) por el Soporte de Wordly.
Una vez que tu cuenta haya sido añadida a la lista de permitidos, puedes crear una clave API que no caduca en el portal:
- Ve a tu página de perfil de usuario en el portal de Wordly.
- Haz clic en el icono de copiar (
) para copiar la clave API en el portapapeles. (Opcional) Haz clic en el icono de actualizar ( 
) para crear una nueva clave API.
Si no ves la fila "Clave API " en tu perfil, significa que tu cuenta no ha sido añadida a la lista de permitidos.
No compartas esta clave sin comprender los riesgos de seguridad. Esta clave debe mantenerse en secreto; de lo contrario, un actor malicioso podría suplantarte y acceder a tu cuenta a través de las APIs. Si sospechas que tu cuenta ha sido comprometida, elimina tu clave API inmediatamente.
Eliminación de una Clave API de Desarrollador
Si deseas eliminar y revocar tu clave API, puedes hacerlo a través del portal.
Para eliminar y revocar tu clave API
Sigue estos pasos para eliminar tu clave API:
- Ve a tu página de perfil de usuario en el portal de Wordly.
-
Haz clic en el botón de la papelera en la fila "Clave API" para eliminar tu clave API.
Puedes generar una nueva clave API después de eliminar la existente.
Encabezado de Autorización (Authorization Header)
Para poder utilizar la API, debes incluir el encabezado x-wordly-api-version con cada solicitud. El valor de este encabezado es tu clave API de desarrollador.
Ejemplo: x-wordly-api-key: f716690b-4e9a-4656-9523-7003637eb6cc
Si no proporcionas la clave API en el encabezado, recibirás una respuesta 401 (No Autorizado) del servidor.
Versionado
A medida que se lancen nuevas versiones de la API, los esquemas de cuerpo de la solicitud y de la respuesta pueden cambiar.
Wordly incluye el encabezado x-wordly-api-version en cada respuesta, lo que te indica a qué versión de la API se ajusta el cuerpo de la respuesta.
Ejemplo: x-wordly-api-version: 1.0
También puedes proporcionar el encabezado x-wordly-api-version en tus solicitudes para fijar el esquema del cuerpo de la solicitud y la respuesta a una versión específica de la API.
Esto asegura que tus solicitudes seguirán funcionando cuando se lancen nuevas versiones de la API.
Si no proporcionas el encabezado x-wordly-api-version en tus solicitudes, Wordly asumirá la última versión de la API. Por esta razón, recomendamos encarecidamente que incluyas este encabezado en cada solicitud.
Si utilizas una versión en el encabezado que ha sido desaprobada, recibirás un error 403 Prohibido. Se avisará con antelación en caso de que una versión de la API sea desaprobada y marcada para su futura eliminación. Encontrarás el aviso en el registro de cambios de la API.
Esto asume que la versión de la API en cuestión todavía es compatible. Se dará aviso anticipado en caso de que una versión de la API sea desaprobada y marcada para su futura eliminación.
Errores
Si ocurre un error mientras se procesa tu solicitud, recibirás una respuesta de error HTTP. En la mayoría de los casos, recibirás un cuerpo de respuesta JSON en el siguiente formato:
{
"message": "An error message will be here.",
"code": 2003,
"errors": [
{
"message": "Any additional error information..."
},
{
"message": "...will be listed here."
}
]
}
El campo código es un código de error numérico específico de Wordly. La siguiente tabla es una lista de posibles códigos de error que puedes recibir en una respuesta de error.
|
Código de Error |
Descripción |
|---|---|
|
2003 |
No está autorizado para realizar esta acción. |
|
2026 |
Un campo no es válido. |
|
2041 |
La operación no se puede completar porque la sesión está en uso. |
|
5001 |
Faltan campos obligatorios en la solicitud. |
|
5002 |
Un campo no es válido. |
|
5004 |
El recurso solicitado no se pudo encontrar. |
Cuerpo de la Solicitud del Webhook de Subtítulos
(Caption Webhook Request Body)
La API de Subtítulos permite que una sesión de Wordly en curso envíe subtítulos en vivo a una URL de webhook designada. Los subtítulos seguirán generándose y enviándose hasta que la sesión de Wordly finalice o hasta que la subtitulación se detenga explícitamente usando la API.
Se debe proporcionar una URL de webhook al realizar la solicitud para iniciar la subtitulación de una sesión de Wordly. A medida que Wordly genera segmentos de subtítulos, se enviarán a la URL del webhook a través de una solicitud POST.
El cuerpo de esta solicitud POST será un único objeto JSON que contiene los siguientes campos.
|
Campo JSON |
Tipo |
Descripción |
|---|---|---|
sequence
|
number |
El número de secuencia para este segmento de subtítulo que define el orden en que deben mostrarse los subtítulos, comenzando con 1. El servicio siempre establecerá esto al valor correcto, y los segmentos de subtítulos se enviarán a la URL del webhook en este orden. Generalmente, los segmentos de subtítulos también llegarán en orden; sin embargo, ten en cuenta que esto no es una garantía debido a las condiciones de red fuera del control de Wordly. Por lo tanto, el número de secuencia se puede utilizar para verificar la ordenación de los segmentos de subtítulos a medida que llegan. |
language
|
string |
Un código de idioma de Wordly. El texto del subtítulo estará en este idioma. |
text
|
string |
El texto real del subtítulo formateado según las configuraciones de subtítulos que se proporcionaron cuando se solicitó la subtitulos. |
duration
|
number |
El tiempo que debe mostrarse el subtítulo en milisegundos. |
IDs de Paquetes de Voz (Voice Pack IDs)
Se pueden asignar IDs de paquetes de voz a las sesiones, que son una asignación curada, uno a uno, de voces a los idiomas disponibles para los asistentes de Wordly. Los asistentes que utilicen la aplicación Wordly Web Attend escucharán transcripciones y traducciones utilizando las voces del paquete especificado si eligen usar la función de texto a voz.
Actualmente, no hay forma de recuperar programáticamente una lista de los paquetes de voz disponibles. Sin embargo, los siguientes paquetes de voz curados se pueden usar al especificar el ID del paquete de voz para una sesión.
|
Nombre del Paquete de Voz |
ID del Paquete de Voz |
|---|---|
|
Voz Femenina |
672def43-f760-451c-82f8-c01711ccaa84 |
|
Voz Masculina |
97cc30b9-a883-47d5-a2d1-0ad89fc69187 |
Si no especificas un paquete de voz al crear una sesión usando la API, la sesión creada utiliza el paquete de voz seleccionado en tu perfil de Wordly. Por defecto, tu perfil estará configurado para usar el paquete de voz predeterminado, que actualmente es la Voz Femenina.
Puedes probar los paquetes de voz para diferentes idiomas al editar una sesión o actualizar tu perfil en el portal de Wordly.