Utilizacion de l'API Revirada

Revirada met a disposicion del public una API mercés a la quala podètz integrar de traduccion automatica dins vòstres programas e aplicacions. Aquela API met a disposicion dos endpoints : un per traduire un tèxte, l'autre per recuperar la tièra de las preferéncias disponiblas.

L'utilizacion de l'API es a gratis mas fa mestièr una clau d'API. Se ne volètz obtenir una, contactatz Lo Congrès :

Mai d'informacions a prepaus de l'inscripcion e l'obtencion d'una clau API : Politica de confidencialitat.

API Revirada

Traducteur automatique occitan - 2.0.0

Base Url : https://gracious-chandrasekhar.193-34-166-21.plesk.page

https://gracious-chandrasekhar.193-34-166-21.plesk.page/api_doc.json

preferences

Security
ApiKeyAuth

La requête doit contenir un header custom nommé 'Api-Key' contenant la clé Api à utiliser pour l'authentification

Responses
Code
Description
200

Retourne la liste des préférences disponibles

Exemple :

[
  {
    "id": "string : Identifiant unique de la préférence",
    "description": [
      {
        "oci": "string : Description de la préférence en Occitan",
        "fra": "string : Description de la préférence en Français"
      }
    ],
    "options": [
      {
        "id": "string : Identifiant unique de l'option",
        "description": [
          {
            "oci": "string : Description de l'option en Occitan",
            "fra": "string : Description de l'option en Français"
          }
        ],
        "example": "string : Exemples de mot réalisés avec cette option",
        "relevantFor": {
          "{code_variante}": "string : Code et nom des variantes"
        },
        "defaultFor": {
          "{code_variante}": "string : Code et nom des variantes"
        }
      }
    ]
  }
]
401

Erreur d'authentification

Exemple :

{
  "status": "integer : Code d'erreur",
  "message": "string : Description de l'erreur"
}

translate_string

Security
ApiKeyBodyAuth

Le Body de la requête doit contenir une propriété nommée 'api_key' contenant la clé Api à utiliser pour l'authentification

Request Body
Nom
Description
content_type
string
* required
Type de contenu à traduire
Valeurs autorisées : [ "txt", "html" ]
text
string
* required
Texte à traduire
source_language
string
* required
Code de la langue source
Valeurs autorisées : [ "fra", "fr", "oci", "oc", "oc-lengadoc-grclass", "oci_gascon", "oc_gascon", "oc-gascon-grclass" ]
target_language
string
* required
Code de la langue cible
Valeurs autorisées : [ "fra", "fr", "oci", "oc", "oc-lengadoc-grclass", "oci_gascon", "oc_gascon", "oc-gascon-grclass" ]
api_key
string
* required
Clé API pour l'authentification
preferences
array<string>
liste des id des options de préférences à utiliser (voir /preferences)
Valeur par défaut: []
Responses
Code
Description
200

Retourne le texte traduit

Exemple :

{
  "original_text": "string : Texte original",
  "translated_text": "string : Texte traduit",
  "words": "integer : Nombre de mots traduits",
  "execution_time": "number : Temps d'exécution (en secondes)"
}
400

Erreur de formatage de la requête

Exemple :

{
  "status": "integer : Code d'erreur",
  "message": "string : Description de l'erreur"
}
401

Erreur d'authentification

Exemple :

{
  "status": "integer : Code d'erreur",
  "message": "string : Description de l'erreur"
}