L'API fon'Òc que permet d'obtiéner la transcripcion en alfabet fonetic d'un mot o d'un tèxte.

L'URL d'entrada

L'URL de basa de l'aplicacion qu'ei http://api.locongres.org/fonoc.php. Que i cau ajustar los paramètres obligatòris. 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 marcar 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".
• Lo contienut a fonetizar : indicatz lo mot o lo tèxte qui voletz fonetizar dab lo paramètre "content".

Per exemple, que's pòt fonetizar lo mot "parlar" en totas las varietats de l'occitan dab l'URL https://api.locongres.org/fonoc.php?key=[la_vòsta_clau_API]&content=parlar. Qu'avetz lo resultat seguent :

Los paramètres facultatius

La varietat

Indicatz la varietat de l'occitan en la quau voletz fonetizar lo contienut dab lo paramètre "var". Qu'accèpta las valors "auvern" (tà l'occitan auvernhat), "gascon" (tà l'occitan gascon), "lemosin" (tà l'occitan lemosin), "lengadoc" (tà l'occitan lengadocian), "provenc" (tà l'occitan provençau), "vivaraup" (tà l'occitan vivaroaupenc).

Per exemple, que's pòt fonetizar lo mot "adiu" en occitan lengadocian dab l'URL https://api.locongres.org/fonoc.php?key=[la_vòsta_clau_API]&content=adiu&var=lengadoc. Qu'avetz lo resultat seguent :

Las ligasons

Indicatz dab lo paramètre "link" si voletz que los mots sián desseparats (link=False) o pegats (link=True). Si las ligasons e son hèitas las -a atònas finaus, per exemple, que desapareisheràn si son seguidas d'ua vocau. Si n'indicatz pas arren, los mots que seràn desseparats per defauta.

Per exemple, que's pòt fonetizar la frasa "Lo mon pair que parla occitan." en occitan gascon, shens las ligasons, dab 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. Qu'avetz lo resultat seguent :

Que's pòt fonetizar la medisha frasa dab las ligasons dab 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. 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à afichar la fonetizacion en occitan gascon de la frasa "Que soi anat dançar" au format XML, dab las ligasons, que's pòt utilizar l'URL http://api.locongres.org/fonoc.php?key=[la_vòsta_clau_API]&content=Que soi anat dançar&var=gascon&link=True&format=xml. Qu'avetz quauquarren com :

Las errors

Si i a errors dens l'URL picada, l'API que 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 indicar un contienut a fonetizar
• 5 : Qua cau indicar ua varietat
• 6 : Varietat incorrècta ("auvern", "gascon", "lemosin", "lengadoc", "provenc" e "vivaraup" permés)
• 7 : La valor deu paramètre "link" que deu estar "True" o "False"
• 8 : Que i aguèt ua error. Mercés de tornar ensajar mei tard o de contactar la nosta equipa se lo problèma contunha.

Las informacions en sortida

En sortida, qu'avetz ua lista de fonetizacions dab un identificant unic. Per caduna qu'ei balhat :

• la varietat deu contienut fontetizat : "oc-auvern" (occitan auvernhat), "oc-gascon" (occitan gascon), "oc-lemosin" (occitan lemosin), "oc-lengadoc" (occitan lengadocian), "oc-provenc" (occitan provençau), "oc-vivaraup" (occitan vivaroaupenc)
• lo contienut fonetizat
• la rima rica deu contienut fonetizat
• la rima paura deu contienut fonetizat

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