L'API sembla-mots que genèra mots qui semblan occitans mes qui n'existeishen pas dens la lenga.

L'URL d'entrada

L'URL de basa de l'aplicacion qu'ei http://api.locongres.org/semblamots.php. Que i cau ajustar los paramètres obligatòris e que s'i pòden 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 longor deu sembla-mot : marcar la longor que voletz tau sembla-mot dab lo paramètre "length". Que deu estar compresa enter 4 e 8.
• La varietat : indicatz en quau varietat de l'occitan e cercatz mots dab lo paramètre "var". Peu moment, qu'accèpta las valors "gascon" (tà l'occitan gascon) e "lengadoc" (tà l'occitan lengadocian).

Per exemple, tà generar un sembla-mot de 5 letras en occitan lengadocian, que's pòt utilizar l'URL http://api.locongres.org/semblamots.php?key=[la_vòsta_clau_API]&length=5&var=lengadoc. Qu'avetz lo resultat seguent :

Los paramètres facultatius

La prumèra letra

Que podetz indicar per quau letra e deu començar lo sembla-mot dab lo paramètre "firstchar". Que pren com valor ua letra occitana shens nat signe diacritic.

Per exemple, tà generar un sembla-mot de 6 letras en occitan gascon qui comença per "a", que's pòt utilizar l'URL http://api.locongres.org/semblamots.php?key=[la_vòsta_clau_API]&length=6&var=gascon&firstchar=a. 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à generar un sembla-mot de 8 letras en occitan gascon au format XML, que's pòt utilizar l'URL http://api.locongres.org/semblamots.php?key=[la_vòsta_clau_API]&length=8&var=gascon&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 : Que cau marcar ua longor
• 5 : Que cau marcar ua varietat
• 6 : Varietat incorrècta ("gascon" e "lengadoc" permés)
• 7 : La longor deu sembla-mot que deu estar compresa enter 4 e 8
• 8 : N'avem pas trobat nat sembla-mot dab las vòstas especificacions

Las informacions en sortida

En sortida, qu'avetz un sembla-mot.

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": 1
        }
    }
}

DTD XML