L'API letras tire des lettres au hasard en respectant leur fréquence dans la langue.
L'URL de base de l'application est http://api.locongres.org/letras.php. Vous devez y ajouter les paramètres obligatoires et vous pouvez y ajouter des paramètres facultatifs. Si vous ne savez pas ajouter des paramètres à un URL, nous vous renvoyons à ce tutoriel.
Il vous faut obligatoirement indiquer les paramètres suivants :
Par exemple, pour tirer des lettres avec une fréquence cohérente avec l'occitan provençal, vous pouvez utiliser l'URL http://api.locongres.org/letras.php?key=[la_vòsta_clau_API]&var=provenc. Vous obtenez le résultat suivant :
{
"query": [
{
"f",
}
]
}
Indiquez le nombre de lettres que vous voulez avec le paramètre "nb". Il prend pour valeur un nombre entre 1 et 50. Si vous ne reseignez pas ce paramètre, par défaut, vous n'aurez qu'une lettre.
Par exemple, si vous voulez tirer 15 lettres en accord avec leur fréquence en occitan languedocien, vous pouvez utiliser l'URL http://api.locongres.org/letras.php?key=[la_vòsta_clau_API]&var=lengadoc&nb=15. Vous obtenez le résultat suivant :
{
"query": [
{
"f",
"a",
"í",
"b",
"s",
"t",
"è",
"m",
"l",
"u",
"ç",
"g",
"s",
"e",
"a",
}
]
}
Indiquez si le tirage doit inclure des lettres accentuées avec le paramètre "acc". Il accepte les valeurs "y" (oui) et "n" (non). Si vous ne reseignez pas ce paramètre, par défaut, vous aurez des lettres accentuées.
Par exemple, si vous voulez tirer 5 lettres non accentuées en accord avec leur fréquence en occitan gascon, vous pouvez utiliser l'URL http://api.locongres.org/letras.php?key=[la_vòsta_clau_API]&var=gascon&nb=5&acc=n. Vous obtenez le résultat suivant :
{
"query": [
{
"j",
"u",
"e",
"b",
"a",
}
]
}
Indiquez si le tirage doit inclure des lettres étrangères (k, w, y) avec le paramètre "foreign". Il accepte les valeurs "y" (oui) et "n" (non). Si vous ne reseignez pas ce paramètre, par défaut, vous n'aurez aucune lettre étrangère.
Par exemple, si vous voulez tirer 10 lettres en accord avec leur fréquence en occitan languedocien, comprenant les lettres k, w et y, vous pouvez utiliser l'URL http://api.locongres.org/letras.php?key=[la_vòsta_clau_API]&var=lengadoc&nb=10&foreign=o. Vous obtenez le résultat suivant :
{
"query": [
{
"j",
"u",
"e",
"b",
"g",
"w",
"a",
"s",
"s",
"a",
}
]
}
Par défaut, le format de sortie est JSON. Mais vous pouvez obtenir une sortie au format XML en ajoutant "format=xml" à l'URL.
Par exemple, pour obtenir 12 lettres en accord avec leur fréquence en occitan provençal au format XML, vous pouvez utiliser l'URL http://api.locongres.org/letras.php?key=[la_vòsta_clau_API]&var=provenc&nb=32&format=xml. Vous obtenez le résultat suivant
<query>
<letter id="1">s</letter>
<letter id="2">i</letter>
<letter id="3">u</letter>
<letter id="4">p</letter>
<letter id="5">s</letter>
<letter id="6">a</letter>
<letter id="7">l</letter>
<letter id="8">o</letter>
<letter id="9">o</letter>
<letter id="10">u</letter>
<letter id="11">l</letter>
<letter id="12">g</letter>
</query>
S'il y a des erreurs dans l'URL ou si la requête ne retourne aucune forme, l'API retourne une erreur avec un code et un texte d'erreur en anglais. Vous trouverez ci-dessous, pour chaque code d'erreur, la traduction de son texte en français :
En sortie, vous obtenez une liste de lettres.
{
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"description": "The unique identifier for an error",
"type": "integer"
},
"text": {
"description": "A description of the error",
"type": "string"
}
},
"required": ["code", "text"]
},
"query": {
"type": "array",
"items": {
"type": "object",
"properties": {
"word": {
"type": "string"
},
"join": {
"type": "string"
},
},
"required": ["word", "join"]
}
}
}
}
<! ELEMENT query (token) >
<! ELEMENT error (#PCDATA) >
<! ATTLIST error code ID #REQUIRED >
<! ELEMENT token (word, join) >
<! ATTLIST token position ID #REQUIRED >
<! ELEMENT join (#PCDATA) >
<! ELEMENT word (#PCDATA) >
© Lo Congrès Permanent de la Lenga Occitana, 2017, tous droits réservés - Contacter Lo Congrès