L'API fon'Òc permet d'obtenir la transcription en alphabet phonétique d'un mot ou d'un texte.

L'URL d'entrée

L'URL de base de l'application est http://api.locongres.org/fonoc.php. Vous devez y ajouter les paramètres obligatoires. 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".
• Le contenu à phonétiser : indiquez le mot ou le texte que vous voulez phonétiser avec le paramètre "content".

Par exemple, vous pouvez phonétiser le mot "parlar" dans toutes les variétés de l'occitan avec l'URL http://api.locongres.org/fonoc.php?key=[votre_clé_API]&content=parlar. Vous obtenez le résultat suivant :

Les paramètres facultatifs

La variété

Indiquez la variété de l'occitan dans laquelle vous voulez phonétiser le contenu avec le paramètre "var". Il accepte les valeurs "auvern" (pour l'occitan auvergnat), "gascon" (pour l'occitan gascon), "lemosin" (pour l'occitan limousin), "lengadoc" (pour l'occitan languedocian), "prov" (pour l'occitan provençal), "vivaraup" (pour l'occitan vivaro-alpin).

Par exemple, vous pouvez phonétiser le mot "adiu" en occitan languedocien avec l'URL http://api.locongres.org/fonoc.php?key=[votre_clé_API]&content=adiu&var=lengadoc. Vous obtenez le résultat suivant :

Les liaisons

Indiquez avec le paramètre "link" si vous voulez que les mots soient séparés (link=False) ou collés (link=True). Si les liaisons sont faites les -a atones finaux, par exemple, disparaîtront s'ils sont suivis d'une voyelle. Si vous n'indiquez rien, les mots seront séparés par défaut.

Par exemple, on peut phonétiser la phrase "Lo mon pair que parla occitan." en occitan gascon, sans les liaisons, avec l'URL https://api.locongres.org/fonoc.php?key=[la_vòsta_clau_API]&content=Lo mon pair que parla occitan&var=gascon&link=False. Vous obtenez le résultat suivant :

On peut phonétiser la même phrase avec les liaisons via l'URL https://api.locongres.org/fonoc.php?key=[la_vòsta_clau_API]&content=Lo mon pair que parla occitan&var=gascon&link=True. 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, pour afficher la phonétisation en occitan gascon de la phrase "Que soi anat dançar" au format XML, vous pouvez utiliser l'URL http://api.locongres.org/fonoc.php?key=[votre_clé_API]&content=Que soi anat dançar&var=gascon&link=True&format=xml. Vous obtenez quelque chose comme :

Les erreurs

S'il y a des erreurs dans l'URL, 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 : Vous devez indiquer un contenu à phonétiser
• 5 : Vous devez indiquer une variété
• 6 : Variété incorrecte ("auvern", "gascon", "lemosin", "lengadoc", "provenc" et "vivaraup" acceptés)
• 7 : La valeur du paramètre "link" doit être "True" ou "False"
• 8 : Une erreur est apparue. Merci de réessayer ultérieurement ou de contacter notre équipe si le problème persiste.

Les informations en sortie

En sortie, vous obtenez une liste de phonétisations avec un identifiant unique. Pour chacune est donné :

• la variété de l'occitan du contenu phonétisé : "oc-auvern" (occitan auvergnat), "oc-gascon" (occitan gascon), "oc-lemosin" (occitan limousin), "oc-lengadoc" (occitan languedocien), "oc-provenc" (occitan provençal), "oc-vivaraup" (occitan vivaro-alpin)
• le contenu phonétisé
• la rime riche du contenu phonétisé
• la rime pauvre du contenu phonétisé

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": "object",
                "properties": {
                    "var": {
                        "type": "string"
                    },
                    "pronunciation": {
                        "type": "string"
                    },
                    "richRhyme": {
                        "type": "string"
                    },
                    "poorRhyme": {
                        "type": "string"
                    },
                },
                "required": ["var", "pronunciation", "richRhyme", "poorRhyme"]
            },
            "minItems": 1
        }
    }
}

DTD XML