Traductions, livres et chapitres
Points d'accès pour parcourir les traductions, consulter la liste des livres et récupérer le contenu des chapitres.
Le contenu des chapitres, les téléchargements de traductions complètes et les annotations au niveau du mot sont disponibles chacun en deux formats :
- Format standard — le format original et structuré. Le contenu du poème est une liste d’éléments (texte brut, texte formaté, notes de bas de page, etc.) que vous assemblez vous-même.
- Format simplifié - un format aplati où le contenu de chaque verset est une seule chaîne de caractères, les notes de bas de page, la poésie et autres balises étant exprimées sous forme de décalages dans cette chaîne.
Utilisez le format qui correspond le mieux à la façon dont vous prévoyez de rendre ou de traiter le texte.
Traductions disponibles
GET https://bible.helloao.org/api/available_translations.json
Obtient la liste des traductions disponibles dans l'API.
Exemple de code
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 https://bible.helloao.org/api/available_translations.jsonStructure
export interface AvailableTranslations {
/**
* La liste des traductions.
*/
translations: Translation[];
}
interface Translation {
/**
* L'identifiant de la traduction.
*/
id: string;
/**
* Le nom de la traduction.
* Il s'agit généralement du nom de la traduction dans la langue de la traduction.
*/
name: string;
/**
* Le nom anglais de la traduction.
*/
englishName: string;
/**
* Le site web de la traduction.
*/
website: string;
/**
* L'URL où se trouve la licence de la traduction.
*/
licenseUrl: string;
/**
* Notes ajoutées par l'API pour la licence.
* Valeur nulle ou indéfinie s'il n'y a pas de notes.
*/
licenseNotes?: string | null;
/**
* Message à afficher lors de l'affichage du contenu traduit.
* Valeur nulle ou indéfinie si la traduction ne comporte pas d'avertissement.
*/
licenseNotice?: string | null;
/**
* Les termes de licence structurés qui ont été détectés pour la traduction.
* Nul ou indéfini si les termes n'ont pas pu être déterminés.
* Dans ce cas, consultez la page à l'adresse licenseUrl pour connaître les conditions.
*/
license?: License | null;
/**
* Nom abrégé de la traduction.
*/
shortName: string;
/**
* L'étiquette de langue ISO 639 à 3 lettres dans laquelle se trouve principalement la traduction.
*/
language: string;
/**
* Obtient le nom de la langue dans laquelle se trouve la traduction.
* Valeur nulle ou indéfinie si le nom de la langue est inconnu.
*/
languageName?: string;
/**
* Obtient le nom de la langue en anglais.
* Valeur nulle ou indéfinie si la langue n'a pas de nom en anglais.
*/
languageEnglishName?: string;
/**
* Le sens dans lequel la langue est écrite.
* « ltr » indique que le texte est écrit de gauche à droite sur la page.
* « rtl » indique que le texte est écrit de la droite vers la gauche.
*/
textDirection: 'ltr' | 'rtl';
/**
* Liste des formats disponibles.
*/
availableFormats: ('json' | 'usfm')[];
/**
* Lien API vers la liste des livres disponibles pour cette traduction.
*/
listOfBooksApiLink: string;
/**
* Le nombre de livres contenus dans cette traduction.
*
* Les traductions complètes devraient comporter le même nombre de livres que la Bible (66).
*/
numberOfBooks: number;
/**
* Le nombre total de chapitres contenus dans cette traduction.
*
* Les traductions complètes devraient avoir le même nombre de chapitres que la Bible (1 189).
*/
totalNumberOfChapters: number;
/**
* Le nombre total de versets contenus dans cette traduction.
*
* Les traductions complètes devraient avoir le même nombre de versets que la Bible (environ 31 102 - certaines traductions excluent des versets en fonction de la probabilité apparente de leur existence dans les textes sources originaux).
*/
totalNumberOfVerses: number;
/**
* Le nombre total de livres apocryphes contenus dans cette traduction.
* Omis si la traduction n'inclut pas les apocryphes.
*/
numberOfApocryphalBooks?: number;
/**
* Le nombre total de chapitres apocryphes contenus dans cette traduction.
* Omis si la traduction n'inclut pas les apocryphes.
*/
totalNumberOfApocryphalChapters?: number;
/**
* le nombre total de versets apocryphes contenus dans cette traduction.
* Omis si la traduction n'inclut pas les apocryphes.
*/
totalNumberOfApocryphalVerses?: number;
}
/**
* Définit les termes de licence structurés qui ont été détectés pour une traduction.
*/
interface License {
/**
* Faut-il mentionner la source originale lors de l'utilisation de la traduction ?
*/
attribution: 'required' | 'not-required';
/**
* L'utilisation commerciale de la traduction est-elle autorisée ?
*/
commercialUse: 'allowed' | 'not-allowed';
/**
* La création et la distribution d'œuvres dérivées de la traduction sont-elles autorisées ?
*/
derivatives: 'allowed' | 'not-allowed';
/**
* La question de savoir si les œuvres dérivées doivent être distribuées sous la même licence (c’est-à-dire une exigence de « partage à l’identique »).
*/
copyleft: boolean;
/**
* Si la traduction a été placée dans le domaine public.
*/
publicDomain: boolean;
}Licences
Chaque traduction est publiée sous sa propre licence, veuillez donc vérifier les conditions d'utilisation avant de l'utiliser.
licenseUrlrenvoie toujours aux conditions générales de la licence.- Le symbole
licenseNotice, lorsqu'il est présent, est la mention de droit d'auteur ou d'attribution à afficher avec le contenu de la traduction. licenseNotescontient des notes ajoutées par l'API, telles que les modifications apportées au texte source.- Le chiffre
license, lorsqu'il est présent, résume les termes sous une forme vérifiable par votre code. Par exemple, vous pouvez filtrer la liste pour ne conserver que les traductions autorisant un usage commercial :
fetch(`https://bible.helloao.org/api/available_translations.json`)
.then(request => request.json())
.then(({ translations }) => {
const commercial = translations.filter(
t => t.license?.commercialUse === 'allowed'
);
console.log('Translations that allow commercial use:', commercial);
});La valeur license n'est attribuée que si les termes peuvent être détectés automatiquement. Les traductions sans cette valeur peuvent néanmoins être utilisables ; consultez la page correspondant à licenseUrl pour plus d'informations.
Exemple
{
"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"
}
]
}Liste de livres en traduction
GET https://bible.helloao.org/api/{translation}/books.json
Obtient la liste des livres disponibles pour la traduction donnée.
translationest l'ID de la traduction (exBSB).
Exemple de code
const translation = 'BSB';
// Obtenez la liste des livres pour la traduction 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 https://bible.helloao.org/api/BSB/books.jsonStructure
export interface TranslationBooks {
/**
* Informations sur la traduction des livres.
*/
translation: Translation;
/**
* Liste des ouvrages disponibles pour la traduction.
*/
books: TranslationBook[];
}
interface TranslationBook {
/**
* L'identifiant du livre.
*/
id: string;
/**
* Le nom que la traduction a donné au livre.
*/
name: string;
/**
* Le nom commun du livre.
*/
commonName: string;
/**
* Le nom court (abréviation) que la traduction a donné au livre.
* Si elle n'est pas disponible, c'est qu'elle n'a pas été fournie par la traduction.
*/
shortName?: string;
/**
* Le titre du livre.
* Il s'agit généralement d'une version plus descriptive du titre du livre.
* Si elle n'est pas disponible, c'est qu'elle n'a pas été fournie par la traduction.
*/
title: string | null;
/**
* L'ordre numérique du livre dans la traduction.
*/
order: number;
/**
* Le nombre de chapitres que contient le livre.
*/
numberOfChapters: number;
/**
* Le numéro du premier chapitre du livre.
*/
firstChapterNumber: number;
/**
* Le lien vers le premier chapitre du livre.
*/
firstChapterApiLink: string;
/**
* Le numéro du dernier chapitre du livre.
*/
lastChapterNumber: number;
/**
* Le lien vers le dernier chapitre du livre.
*/
lastChapterApiLink: string;
/**
* Le nombre de versets que contient le livre.
*/
totalNumberOfVerses: number;
/**
* Que le livre soit apocryphe.
* Omis si la traduction est canonique.
*/
isApocryphal?: boolean;
}Exemple
{
"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",
"shortName": "Gen",
"title": "Genesis",
"order": 1,
"numberOfChapters": 50,
"firstChapterNumber": 1,
"firstChapterApiLink": "/api/BSB/GEN/1.json",
"lastChapterNumber": 50,
"lastChapterApiLink": "/api/BSB/GEN/50.json",
"totalNumberOfVerses": 1533
},
]
}