API de Transcripción

Facilitando la gestión de transcripciones de manera sencilla y eficiente.

1. Introducción

La API de Transcripción está diseñada para facilitar la subida de archivos de transcripción y la gestión de estos archivos. Permite a los usuarios cargar archivos en formato HTML, los cuales pueden ser procesados y consultados mediante diversos endpoints.

Esta API es ideal para sistemas que requieren la integración de transcripciones automatizadas o generadas manualmente. Es particularmente útil en plataformas donde los usuarios necesitan gestionar o compartir archivos de transcripción como parte de su flujo de trabajo.

La API proporciona un conjunto de endpoints RESTful que permiten a los usuarios interactuar con el sistema para realizar tareas como la subida de archivos o la consulta de transcripciones. El uso de esta API requiere conocimientos básicos de HTTP y JavaScript.

2. Requisitos Previos

Antes de comenzar a utilizar la API, asegúrate de que tu entorno de desarrollo esté configurado adecuadamente:

  • Node.js: Descarga e instala Node.js desde su sitio oficial.
  • Librerías necesarias:
    • axios: Para realizar solicitudes HTTP.
    • discord-html-transcripts: Para generar transcripciones HTML desde Discord (opcional).
    • fs: Para interactuar con el sistema de archivos local.

Si no tienes experiencia configurando entornos de desarrollo, te recomendamos seguir algún tutorial sobre Node.js.

3. Endpoints

POST /upload

Este endpoint permite subir un archivo de transcripción al servidor.

Parámetros:

  • file: Archivo HTML con la transcripción.

Ejemplo de uso:


const formData = new FormData();
formData.append('file', file, `${interaction.user.id}.html`);
axios.post('apps.quetzalbyte.lat/api/transcript/upload', formData, {
  headers: { 'Content-Type': 'multipart/form-data' }
}).then(response => {
  console.log('Archivo subido exitosamente', response);
}).catch(error => {
  console.error('Error al subir el archivo', error);
});
          

GET /transcripts/:filename

Este endpoint permite obtener un archivo de transcripción previamente cargado.

Parámetros:

  • filename: Nombre del archivo a consultar.

Ejemplo de uso:


// Ejemplo de URL
https://apps.quetzalbyte.lat/api/transcripts/mi_transcripcion.html
          
Regresar a la página principal