API de Traducción de Pangeanic

Manual de Usuario - API de Glosarios 

Introducción 

Esta API permite gestionar glosarios asociados a motores de traducción o procesamiento. Los endpoints disponibles permiten: listar glosarios, eliminar glosarios y agregar nuevos glosarios. Todos los endpoints son accesibles mediante el método HTTP POST. 

Autenticación 

Todos los endpoints requieren el parámetro apikey para autenticar al usuario. Si no se proporciona, la API responderá con un error 400. 

Endpoint: Obtener Glosarios 

URL: /glossaries 

Método: POST 

Content-Type: application/json; charset=UTF-8 

Descripción: Devuelve una lista de glosarios disponibles para el apikey y opcionalmente filtrados por glossaryid. 

Ejemplo de un request 

        { 
          "apikey": "tu_apikey", 
          "glossaryid": 123  // Opcional para seleccionar un glosario 
        } 

Respuesta Exitosa 

[ 
  { 
    "id": 1, 
    "name": "Glosario Médico", 
    "path": "/glossaries/medico.csv" 
  }, 
  { 
    "id": 2, 
    "name": "Glosario Legal", 
    "path": "/glossaries/legal.csv" 
  } 
] 

Errores Comunes 

- 400: JSON mal formado o falta apikey 
- 401: Error inesperado al recuperar glosarios 

Endpoint: Eliminar Glosario 

URL: /deleteglossary 

Método: POST 

Content-Type: application/json; charset=UTF-8 

Descripción: Elimina un glosario específico. 

Ejemplo de un request 

{ 
  "apikey": "tu_apikey", 
  "glossaryid": 123 
} 

Respuesta Exitosa 

{ 
  "status": "success", 
  "message": "Glossary deleted successfully" 
} 

Errores Comunes 

- 400: Falta apikey o glossaryid 
- 401: Error inesperado 
- 500: Error de base de datos 

Endpoint: Agregar Glosario 

URL: /addglossary 

Método: POST 

Content-Type: multipart/form-data 

Descripción: Permite subir un archivo de glosario y asociarlo a un motor. 

Parámetros del Formulario 

Ejemplo de una respuesta Exitosa 

{ 
  "status": "success", 
  "message": "Glossary added successfully", 
  "id": 456 
} 

Errores Comunes 

- 400: Falta alguno de los campos requeridos 
- 401: Error inesperado 
- 500: Error de base de datos 

Ejemplos de uso con curl 

Obtener glosarios 

curl -X POST http://tuapi.com/glossaries \ 
  -H "Content-Type: application/json" \ 
  -d '{"apikey":"abc123"}' 

Eliminar glosario 

curl -X POST http://tuapi.com/deleteglossary \ 
  -H "Content-Type: application/json" \ 
  -d '{"apikey":"abc123", "glossaryid": 1}' 

Agregar glosario 

curl -X POST http://tuapi.com/addglossary \ 
  -F "file=@/ruta/al/archivo.csv" \ 
  -F "name=Glosario Nuevo" \ 
  -F "engineid=2" \ 
  -F "apikey=abc123"