Convertisseur de texte
HTML ◄--► BBcode

Les paramètres d'appel à l'API de conversion

Vous trouverez ici la description de chaque paramètre que vous pouvez envoyer à l'API de Keetag pour convertir vos textes. Vous pouvez réaliser vos conversions avec seulement trois paramètres, tous les autres sont facultatifs. Les paramètres doivent être envoyés à la page de l'API (https://keetag.net/en/api/v1/converter) via la méthode HTTP POST.

Paramètres obligatoires :

Paramètres facultatifs :


text_to_convert

Type : texte
Obligatoire : oui

Ce paramètre est le plus important car il contient le texte que vous voulez convertir. Vous avez deux possibilités :

Utilisez de préférence la première méthode (fourniture directe du texte à convertir) car elle est significativement plus rapide. Si vous fournissez l'adresse de la page, il faut ajouter le temps de récupération de la page (variable en fonction de la réactivité du serveur distant) au temps de conversion proprement dit.


orig_language_id

Type : nombre entier (integer)
Obligatoire : oui
Exemple de valeur : 8

Indiquez avec ce paramètre l'ID (numéro) du langage d'origine, en consultant la liste des IDs des langages.

Le langage d'origine est le langage avec lequel est balisé le texte que vous voulez convertir. Par exemple, si votre texte a été rédigé en BBCode et que vous voulez le convertir en HTML, le langage d'origine est le BBCode. Comme indiqué dans le tableau, la valeur de orig_language_id sera donc 2.


destin_language_id

Type : nombre entier (integer)
Obligatoire : oui
Exemple de valeur : 12

Indiquez avec ce paramètre l'ID (numéro) du langage de destination, en consultant la liste des IDs des langages.

Le langage de destination est le langage vers lequel vous voulez convertir votre texte. Par exemple, si votre texte a été rédigé en BBCode et que vous voulez le convertir en HTML, le langage de destination est le HTML. Comme indiqué dans le tableau, la valeur de destin_language_id sera donc 1.


page_url

Type : chaîne de texte
Obligatoire : non (valeur par défaut : chaîne vide)
Exemple de valeur : https://domain.here/page.html

L'URL de la page source à convertir, si le texte à convertir est une page HTML. Ceci permettra de transformer les éventuels liens relatifs contenus dans votre texte en liens absolus.

Puisque êtes en train de lire une documentation d'API, vous savez normalement déjà ce qu'est un lien relatif. Si ce n'était pas le cas malgré tout, voici un article expliquant très simplement (et plus clairement que Wikipédia) ce qu'est un lien relatif.

Indiquez l'adresse complète de la page à convertir, le convertisseur saura en extraire la bonne partie pour corriger les liens. Par exemple, si la page se trouve à https://domain.here/actualite/article.html, indiquez cette adresse et pas juste https://domain.here/actualite/.

Précisions sur le paramètre page_url :


Type : booléen
Obligatoire : non (valeur par défaut : TRUE)
Valeurs possibles : TRUE ou FALSE

Par défaut, le convertisseur corrige les éventuels liens relatifs présents dans votre texte en liens absolus. Si vous définissez ce paramètre à FALSE, cette transformation ne sera pas réalisée.

Puisque êtes en train de lire une documentation d'API, vous savez normalement déjà ce qu'est un lien relatif. Si ce n'était pas le cas malgré tout, voici un article expliquant très simplement (et plus clairement que Wikipédia) ce qu'est un lien relatif.

Vous ne devriez mettre ce paramètre sur FALSE que si vous avez une bonne raison de le faire car s'il est désactivé, les liens relatifs resteront cassés (à moins que le texte converti soit replacé ensuite au même endroit que la page d'origine). A priori, la seule hypothèse valable de le faire est celle où vous ne connaîtriez pas l'adresse d'origine du texte que vous convertissez.

La correction des liens relatifs nécessite que vous fournissiez l'adresse du texte d'origine avec le paramètre page_url.


return_html_preview

Type : booléen
Obligatoire : non (valeur par défaut : FALSE)
Valeurs possibles : TRUE ou FALSE

Si vous définissez cette option à TRUE, l'API vous retournera un aperçu HTML du texte converti (identique à celui affiché sur le convertisseur en ligne) dans la valeur de retour html_preview. Par défaut, cette option n'est pas activée car elle fait doubler le volume de texte à transférer (le texte converti normal + l'aperçu HTML).


return_unknown_tags_list

Type : booléen
Obligatoire : non (valeur par défaut : FALSE)
Valeurs possibles : TRUE ou FALSE

Si vous définissez cette option à TRUE, l'API vous retournera la liste des éventuelles balises non reconnues de votre texte dans la valeur de retour unknown_tags_list. Par défaut, cette liste n'est pas retournée car elle peut faire augmenter le volume de données à transférer si le texte contient beaucoup d'erreurs.


remove_unknown_tags

Type : booléen
Obligatoire : non (valeur par défaut : FALSE)
Valeurs possibles : TRUE ou FALSE

Si vous définissez cette option à TRUE, les éventuelles balises non reconnues par le convertisseur seront complètement supprimées, au lieu d'être conservées telles quelles dans le texte. Comme dans la version en ligne du convertisseur, cette option n'est pas activée par défaut car elle peut causer des comportements imprévus (problèmes d'espaces...).


prettify_json

Type : booléen
Obligatoire : non (valeur par défaut : FALSE)
Valeurs possibles : TRUE ou FALSE

Par défaut, le flux JSON retourné est minifié, c'est-à-dire présenté sur une seule ligne. Si vous définissez ce paramètre à TRUE, le JSON sera indenté et comportera des retours à la ligne. Cela vous facilitera la lecture lorsque vous développez vos scripts. Une fois vos développements terminés, vous pouvez désactiver cette option car l'indentation n'a aucun intérêt dans le cadre d'un traitement automatique. Notez cependant que l'activation ou non de ce paramètre n'a pas d'impact significatif sur les performances.

Certains navigateurs – notamment Firefox – indentent d'office les flux JSON. Si vous visualisez le flux dans un tel navigateur, vous n'avez pas besoin d'activer prettify_json.

Certains navigateurs moins avancés traitent le JSON comme s'il s'agissait de HTML. Ils l'affichent donc sans retours à la ligne même si prettify_json est activé (puisqu'en HTML, seule la balise <br/> crée un retour à la ligne). Pour voir les effets de prettify_json, vous devrez afficher le code source de la page.