L'API sembla-mots génère des mots qui semblent occitans mais qui n'existent pas dans la langue.

L'URL d'entrée

L'URL de base de l'application est http://api.locongres.org/semblamots.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.

Les paramètres obligatoires

Il vous faut obligatoirement indiquer les paramètres suivants :

• Votre clé API : pour utiliser les API du Congrès, il vous faut indiquer une clé API personnelle que nous pouvons vous fournir sur la page dédiée. Vous l'indiquez avec le paramètre "key".
• La longueur du pseudo-mot : indiquez la longueur désirée avec le paramètre "length". Il accepte une valeur entre 4 et 8.
• La variété : indiquez dans quelle variété de l'occitan vous recherchez des mots avec le paramètre "var". Pour le moment, il accepte les valeurs "gascon" (pour l'occitan gascon) et "lengadoc" (pour l'occitan languedocien).

Par exemple, si vous voulez générer un pseudo-mot de 5 lettres en occitan languedocien, vous pouvez utiliser l'URL http://api.locongres.org/semblamots.php?key=[la_vòsta_clau_API]&length=5&var=lengadoc. Vous obtenez le résultat suivant :

Les paramètres facultatifs

La première lettre

Vous pouvez indiquer par quelle lettre doit commencer le non-mot avec le paramètre "firstchar". Il accepte comme valeur une lettre occitane sans signe diacritique.

Par exemple, si vous voulez générer un non-mot de 6 lettres en occitan gascon qui commence par "a", vous pouvez utiliser l'URL http://api.locongres.org/semblamots.php?key=[la_vòsta_clau_API]&length=6&var=gascon&firstchar=a. Vous obtenez le résultat suivant :

Le format de sortie

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, si vous voulez rechercher un pseudo-mot de 8 lettres en occitan gascon au format XML, vous pouvez utiliser l'URL http://api.locongres.org/semblamots.php?key=[la_vòsta_clau_API]&length=8&var=gascon&format=xml. Vous obtenez le résultat suivant

Les erreurs

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 :

• 1 : Vous devez indiquer une clé API
• 2 : Clé API invalide
• 3 : Format incorrect ("json" et "xml" acceptés)
• 4 : Il vous faut indiquer une longueur
• 5 : Il vous faut indiquer une variété
• 6 : Variété incorrecte ("gascon" et "lengadoc" acceptés)
• 7 : La longueur du pseudo-mot doit être comprise entre 4 et 8
• 8 : Nous n'avons trouvé aucun pseudo-mot avec vos spécifications

Les informations en sortie

En sortie, vous obtenez un pseudo-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