/himnario-adventista-api

REST API based on the spanish Adventist Hymnal 🎼

Primary LanguageTypeScript

Himnario Adventista API

¿Qué es?

Es una API que permite obtener la letra y la música (instrumental y cantado) de las canciones del Himnario Adventista Edición 2009.

¿Cómo usarla?

La API se encuentra en la siguiente dirección: https://sdah.my.to/hymn.

⚠️ Esta API está en constante desarrollo y puede cambiar en cualquier momento.

¿Dónde está hosteada la música?

La música está hosteada en Google Drive y está disponible para su descarga.

Endpoints

Método Endpoint Descripción
GET /hymn Devuelve un Array con todas las canciones.

Responses

Código Response
200 Hymn[]

Método Endpoint Descripción
GET /hymn/:number Devuelve el contenido de la canción y la secuencia de estrofas.

Responses

Código Response
200 HymnHistory
404 Hymn not found

Esquemas

interface Hymn = {
  id:           number  // ID de la canción
  number:       number  // número de la canción
  title:        string  // título de la canción
  mp3Url:       string  // URL del archivo mp3
  mp3UrlInstr:  string  // URL del archivo mp3 con la pista instrumental
  mp3Filename:  string  // nombre del archivo mp3
}
interface HymnSequence =  {
  id:               number  // ID de la canción
  number:           number  // número de la canción
  title:            string  // título de la canción
  mp3Url:           string  // URL del archivo mp3
  mp3UrlInstr:      string  // URL del archivo mp3 con la pista instrumental
  mp3Filename:      string  // nombre del archivo mp3
  verses: {
    id:             number  // ID de la estrofa
    number:         number  // número de la estrofa (0 si es el coro)
    contents: {
      id:           number  // ID del contenido
      content:      string  // contenido de la estrofa
    }[]
  }[]
  sequence: {
    id:             number  // ID de la secuencia
    timestamp:      number  // marca de tiempo en milisegundos del mp3
    verseId:        number  // ID de la estrofa
    verseContentId: number  // ID del contenido de la estrofa
  }[]
}