Développeurs

POINT DE TERMINAISON DE SERVICE

BibleGet utilise un service d'e/s de type « Point final » sur votre propre serveur qui est exposée à des applications, pour permettre aux applications d'interroger le serveur avec une requête qui effectue une demande de quotation biblique. La demande envoyée par l'application de point de terminaison retournera des données structurées au format utile pour la même application (comme le format JSON qui est une structure de données de Javascript, mais qui est couramment utilisé pour l'échange des données structurées entre les applications ou services web ou langues ; un exemple d'application pourrait être un plugin pour WordPress, ou une extension pour Microsoft Word qui permettent à un utilisateur unique exécuter automatisé des citations de l'Ecriture). Dans la pratique le point de terminaison de Service est un script PHP qui prend une requête qui contient une notation standard pour les citations bibliques et il traduit des requêtes MySQL, mise en forme des résultats dans le format requis, qui peut être de type JSON, XML ou HTML.

POINT DE TERMINAISON URL

L'url principale pour les demandes est http://query.bibleget.io/(which corresponds to http://www.bibleget.io/query/). Il met actuellement au point un moteur de PHP plus avancé, qui est actuellement situé à l'URL http://query.bibleget.io/index2.php. Ce nouveau moteur permet de faire des demandes dans toutes les langues (les livres de la Bible peuvent figurer dans l'une des nombreuses langues différentes, il existe actuellement albanais, anglais, FRANÇAIS, allemand, hongrois, italien, polonais, roumain, russe, espagnol, TAGALOG), ainsi que ce qui vous permet d'indiquer la version biblique que vous voulez.

PARAMÈTRES

Les paramètres que vous pouvez envoyer au point de terminaison sont :

• « requête » *: ce paramètre est obligatoire. Sa valeur doit correspondre à une demande valide qui utilise la notation standard pour les citations bibliques. Voir la notation Standard de section pour les citations bibliques dans les informations à l'utilisateur.
• « version »: (facultatif) si vous ne spécifiez pas ce paramètre, la valeur par défaut est « cei2008 ».  Avec ce paramètre, vous pouvez spécifier la version biblique que vous souhaitez. Vous pouvez également spécifier plusieurs versions répertoriées avec virgule, de comparer plusieurs versions des textes. Actuellement, il y a seulement des versions « cei2008 » et « luzzi ».
• « retour »: (facultatif) c'est le format dans lequel vous souhaitez retourner des données structurées. Le paramètre prend l'une des trois valeurs suivantes: "json", "xml", ou « html ».

COMMENT INTERROGER LE POINT DE TERMINAISON

La requête peut être faite de différentes façons au point de terminaison :

• de PHP en utilisant CURL
• de Javascript avec un appel AJAX (qui pourrait également utiliser un script PHP qui utilise CURL)
• attribut « src » comme un élément « iframe » dans une page HTML (et en utilisant le "retour = html")
• tout langage ou l'application qui peut faire un appel à une URL peut interroger le service et traiter les données reçues. En Java, par exemple, il existe des bibliothèques qui vous permettent d'effectuer des appels vers des URL.

Exemple de requête : http://query.bibleget.io/?query=Mt1, 1-10; 2, 2-4 & retour = html. Essayez de cliquer sur ce lien pour voir un exemple de données retournées, ici au format HTML avec mise en forme et de structure minimaliste. Maintenant essayer celui-ci qui renvoie les mêmes données au format JSON, sans structure de mise en forme ou de la page : http://query.bibleget.io/?query=Mt1, 1-10; 2, 2-4 & retour = json.

Exemple de requête pour le nouveau moteur développant : requête http://query.bibleget.io/index2.php? = Matthäus1:1-10 ; 2:2-4 & version = cei2008, luzzi & retour = html.

Vous pouvez essayer vous-même pour formuler certaines requêtes et voir le type de réponsArea Sandboxe.