Traduções, livros e capítulos
Pontos de extremidade para navegar pelas traduções, listar seus livros e obter o conteúdo dos capítulos.
O conteúdo dos capítulos, os downloads da tradução completa e as anotações em nível de palavra estão disponíveis em dois formatos:
- Formato padrão - o formato original e estruturado. O conteúdo do verso é uma lista de elementos (texto simples, texto formatado, referências em notas de rodapé, etc.) que você mesmo compila.
- Formato simplificado - um formato plano onde o conteúdo de cada verso é uma única sequência de caracteres, com notas de rodapé, poesia e outras marcações expressas como deslocamentos dentro dessa sequência.
Use o formato que melhor se adapte à maneira como você planeja renderizar ou processar o texto.
Traduções disponíveis
GET https://bible.helloao.org/api/available_translations.json
Obtém a lista de traduções disponíveis na API.
Exemplo de código
JavaScript
fetch(`https://bible.helloao.org/api/available_translations.json`)
.then(request => request.json())
.then(availableTranslations => {
console.log('The API has the following translations:', availableTranslations);
});cURL
curl https://bible.helloao.org/api/available_translations.jsonEstrutura
export interface AvailableTranslations {
/**
* A lista de traduções.
*/
translations: Translation[];
}
interface Translation {
/**
* O ID da tradução.
*/
id: string;
/**
* O nome da tradução.
* Normalmente, esse é o nome da tradução no idioma original.
*/
name: string;
/**
* O nome em inglês da tradução.
*/
englishName: string;
/**
* O site para a tradução.
*/
website: string;
/**
* O endereço URL onde se encontra a licença da tradução.
*/
licenseUrl: string;
/**
* Nome abreviado da tradução.
*/
shortName: string;
/**
* A etiqueta de idioma ISO 639 de 3 letras na qual a tradução se encontra principalmente.
*/
language: string;
/**
* Obtém o nome do idioma em que a tradução está sendo feita.
* Nulo ou indefinido se o nome do idioma for desconhecido.
*/
languageName?: string;
/**
* Obtém o nome do idioma em inglês.
* Nulo ou indefinido se o idioma não tiver um nome em inglês.
*/
languageEnglishName?: string;
/**
* A direção em que a língua é escrita.
* "ltr" indica que o texto é escrito da esquerda para a direita na página.
* "rtl" indica que o texto é escrito da direita para a esquerda na página.
*/
textDirection: 'ltr' | 'rtl';
/**
* Lista de formatos disponíveis.
*/
availableFormats: ('json' | 'usfm')[];
/**
* O link da API para a lista de livros disponíveis para esta tradução.
*/
listOfBooksApiLink: string;
/**
* O número de livros contidos nesta tradução.
*
* As traduções completas devem ter o mesmo número de livros que a Bíblia (66).
*/
numberOfBooks: number;
/**
* O número total de capítulos contidos nesta tradução.
*
* As traduções completas devem ter o mesmo número de capítulos que a Bíblia (1.189).
*/
totalNumberOfChapters: number;
/**
* O número total de versículos contidos nesta tradução.
*
* As traduções completas devem ter o mesmo número de versículos que a Bíblia (cerca de 31.102 - algumas traduções excluem versículos com base na aparente probabilidade de existirem nos textos originais).
*/
totalNumberOfVerses: number;
/**
* O número total de livros apócrifos contidos nesta tradução.
* Omitido se a tradução não incluir apócrifos.
*/
numberOfApocryphalBooks?: number;
/**
* O número total de capítulos apócrifos contidos nesta tradução.
* Omitido se a tradução não incluir apócrifos.
*/
totalNumberOfApocryphalChapters?: number;
/**
* o número total de versículos apócrifos contidos nesta tradução.
* Omitido se a tradução não incluir apócrifos.
*/
totalNumberOfApocryphalVerses?: number;
}Exemplo
{
"translations": [
{
"id": "BSB",
"name": "Berean Standard Bible",
"website": "https://berean.bible/",
"licenseUrl": "https://berean.bible/",
"shortName": "BSB",
"englishName": "Berean Standard Bible",
"language": "eng",
"textDirection": "ltr",
"availableFormats": [
"json"
],
"listOfBooksApiLink": "/api/BSB/books.json",
"numberOfBooks": 66,
"totalNumberOfChapters": 1189,
"totalNumberOfVerses": 31086,
"languageName": "English",
"languageEnglishName": "English"
}
]
}Lista de livros traduzidos
GET https://bible.helloao.org/api/{translation}/books.json
Obtém a lista de livros disponíveis para a tradução especificada.
translationé o ID da tradução (ex:BSB).
Exemplo de código
JavaScript
const translation = 'BSB';
// Obtenha a lista de livros para a tradução BSB.
fetch(`https://bible.helloao.org/api/${translation}/books.json`)
.then(request => request.json())
.then(books => {
console.log('The BSB has the following books:', books);
});cURL
curl https://bible.helloao.org/api/BSB/books.jsonEstrutura
export interface TranslationBooks {
/**
* Informações sobre a tradução dos livros.
*/
translation: Translation;
/**
* Lista de livros disponíveis para tradução.
*/
books: TranslationBook[];
}
interface TranslationBook {
/**
* A identificação do livro.
*/
id: string;
/**
* O nome que a tradução deu ao livro.
*/
name: string;
/**
* Nome comum do livro.
*/
commonName: string;
/**
* O título do livro.
* Essa geralmente é uma versão mais descritiva do nome do livro.
* Caso não esteja disponível, significa que a tradução não forneceu nenhuma.
*/
title: string | null;
/**
* A ordem numérica do livro na tradução.
*/
order: number;
/**
* O número de capítulos que o livro contém.
*/
numberOfChapters: number;
/**
* O número do primeiro capítulo do livro.
*/
firstChapterNumber: number;
/**
* O link para o primeiro capítulo do livro.
*/
firstChapterApiLink: string;
/**
* O número do último capítulo do livro.
*/
lastChapterNumber: number;
/**
* O link para o último capítulo do livro.
*/
lastChapterApiLink: string;
/**
* O número de versículos que o livro contém.
*/
totalNumberOfVerses: number;
/**
* Se o livro é apócrifo ou não.
* Omitido se a tradução for canônica.
*/
isApocryphal?: boolean;
}Exemplo
{
"translation": {
"id": "BSB",
"name": "Berean Standard Bible",
"website": "https://berean.bible/",
"licenseUrl": "https://berean.bible/",
"shortName": "BSB",
"englishName": "Berean Standard Bible",
"language": "eng",
"textDirection": "ltr",
"availableFormats": [
"json"
],
"listOfBooksApiLink": "/api/BSB/books.json",
"numberOfBooks": 66,
"totalNumberOfChapters": 1189,
"totalNumberOfVerses": 31086,
"languageName": "English",
"languageEnglishName": "English"
},
"books": [
{
"id": "GEN",
"translationId": "BSB",
"name": "Genesis",
"commonName": "Genesis",
"title": "Genesis",
"order": 1,
"numberOfChapters": 50,
"firstChapterNumber": 1,
"firstChapterApiLink": "/api/BSB/GEN/1.json",
"lastChapterNumber": 50,
"lastChapterApiLink": "/api/BSB/GEN/50.json",
"totalNumberOfVerses": 1533
},
]
}