L'API letras que tira letras a l'azard en respectant la lor frequéncia dens la lenga.

L'URL d'entrada

L'URL de basa de l'aplicacion qu'ei http://api.locongres.org/letras.php. Que i cau ajustar los paramètres obligatòris e que s'i pòt ajustar paramètres facultatius. Si ne sabetz pas ajustar paramètres a un URL, que'vs renviam a aqueth tutoriau.

Los paramètres obligatòris

Que cau obligatòriament indicar los paramètres seguents :

• La vòsta clau API : tà utilizar las API deu Congrès, que cau indicar ua clau API personau qui'vs podem balhar sus la pagina dedicada. Que la cau marcar dab lo paramètre "key".
• La varietat : indicatz la varietat a partir de la quau e cau calcular la frequéncia de las letras dab lo paramètre "var". Qu'accèpta las valors "gascon" (tà l'occitan gascon), "lengadoc" (tà l'occitan lengadocian) e "provenc" (tà l'occitan provençau).

Per exemple, tà tirar letras dab ua frequéncia coerenta dab l'occitan provençau, que's pòt utilizar l'URL http://api.locongres.org/letras.php?key=[la_vòsta_clau_API]&var=provenc. Qu'avetz lo resultat seguent :

Los paramètres facultatius

Lo nombre de letras

Indicatz lo nombre de letras qui voletz dab lo paramètre "nb". Que pren per valor una chifra enter 1 e 50. Si non datz pas aqueth paramètre, per defaut qu'averetz sonque ua letra.

Per exemple, si voletz tirar 15 letras en acòrdi dab la lor frequéncia en occitan lengadocian, que's pòt utilizar l'URL http://api.locongres.org/letras.php?key=[la_vòsta_clau_API]&var=lengadoc&nb=15. Qu'avetz lo resultat seguent :

Los accents

Indicatz si lo tiratge e deu includir letras accentuadas dab lo paramètre "acc". Qu'accèpta las valors "y" (òc) e "n" (non). Si non datz pas aqueth paramètre, per defaut qu'averetz letras accentuadas.

Per exemple, si voletz tirar 5 letras shens nat accent en acòrdi dab la lor frequéncia en occitan gascon, que's pòt utilizar l'URL http://api.locongres.org/letras.php?key=[la_vòsta_clau_API]&var=gascon&nb=5&acc=n. Qu'avetz lo resultat seguent :

Las letras estrangèras

Indicatz si lo tiratge e deu includir letras estrangèras (k, w, y) dab lo paramètre "foreign". Qu'accèpta las valors "y" (òc) e "n" (non). Si non datz pas aqueth paramètre, per defaut n'averetz pas nada letra estrangèra.

Per exemple, si voletz tirar 10 letras en acòrdi dab la lor frequéncia en occitan lengadocian, comprenent las letras k, w e y, que's pòt utilizar l'URL http://api.locongres.org/letras.php?key=[la_vòsta_clau_API]&var=lengadoc&nb=10&foreign=o. Qu'avetz lo resultat seguent :

Lo format de sortida

Per defaut, lo format de sortida qu'ei JSON. Mes que's pòt aver ua sortida au format XML en ajustant "format=xml" a l'URL.

Per exemple, tà obtiéner 12 letras en acòrdi dab la lor frequéncia en occitan provençau au format XML, que's pòt utilizar l'URL http://api.locongres.org/letras.php?key=[la_vòsta_clau_API]&var=provenc&nb=32&format=xml. Qu'avetz lo resultat seguent

Las errors

Si i a errors dens l'URL picada o que la requèsta ne torna pas nada forma, l'API que'vs torna ua error dab un còdi e un tèxte d'error en anglés. Qu'avetz ací-devath, tà cada còdi d'error, la revirada deu son tèxte en occitan :

• 1 : Que cau indicar ua clau API
• 2 : Clau API invalida
• 3 : Format incorrècte ("json" e "xml" permés)
• 4 : Lo nombre de letras que deu estar comprés enter 1 e 50
• 5 : Que'vs cau indicar ua varietat
• 6 : Varietat incorrècta ("gascon", "lengadoc" e "provenc" permés)
• 7 : Las valors autorizada tau paramètre "foreign" que son "y" e "n"
• 8 : Las valors autorizada tau paramètre "acc" que son "y" e "n"
• 9 : Que i avó ua error. Que'vs pregam de tornar ensajar.

Las informacions en sortida

En sortida, qu'avetz ua lista de letras.

JSON schema

{
    "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": "string"
            },
            "minItems": 1,,
            "maxItems": 50
        }
    }
}

DTD XML