API et modules

API fon'Òc - Mode d'emploi

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 :

{
    "query": [
        {
            "pronunciation":"/par/'la",
            "var":"oc-lengadoc",
        {
            "pronunciation":"/par/'la",
            "var":"oc-gascon",
        {
            "pronunciation":"/paʀ/'laʀ",
            "var":"oc-provenc",
        {
            "pronunciation":"/paʀ/'laʀ",
            "var":"oc-vivaraup",
        {
            "pronunciation":"/par/'la",
            "var":"oc-auvern",
        {
            "pronunciation":"/par/'la",
            "var":"oc-lemosin",
    ]
}

Le paramètre facultatif

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 :

{
    "query": [
        {
            "pronunciation": "/a/'diw",
            "var": "oc-lengadoc",
        }
    ]
}

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&format=xml. Vous obtenez quelque chose comme :

<query>
    <phon id="1">
        <pronunciation>/'ke/'su/ja/'nat/dan/'sa</pronunciation>
        <var>oc-gascon</var>
    </phon>
</query>

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)

Les informations en sortie

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

  • le contenu phonétisé
  • sa variété de l'occitan : "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)

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

DTD XML

<! ELEMENT query (phon) >

<! ELEMENT error (#PCDATA) >
<! ATTLIST error code ID #REQUIRED >

<! ELEMENT phon (pronunciation, var) >

<! ELEMENT pronunciation (#PCDATA) >

<! ELEMENT var (#PCDATA) >

© Lo Congrès Permanent de la Lenga Occitana, 2017, tous droits réservés - Contacter Lo Congrès