API e modules

API fon'Òc - Mòde d'emplec

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 :

{
    "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",
    ]
}

Lo paramètre facultatiu

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 :

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

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, 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&format=xml. Qu'avetz quauquarren com :

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

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
  • 5 : Varietat incorrècta ("auvern", "gascon", "lemosin", "lengadoc", "provenc" e "vivaraup" permés)

Las informacions en sortida

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

  • lo contienut fonetizat
  • la soa varietat : "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)

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, tots los drets reservats - Contactar Lo Congrès