📦 Uso de la API de CORDIA
Este documento explica cómo consumir la API de CORDIA desde clientes externos, editores o herramientas como Postman. Está basada en el estándar REST y requiere autenticación mediante JWT para la mayoría de operaciones.
🔑 Autenticación
Para acceder a los endpoints protegidos necesitas un token JWT:
- Envía una solicitud POST a
/logincon email y contraseña - Recibirás un token en la respuesta
- Añade este token a todas las peticiones como encabezado:
Authorization: Bearer {token}
🌐 URL base de la API
- Entorno local:
http://api.cordia.local - Entorno preproducción:
https://api.cordia.marcostorrent.com
Todos los endpoints comienzan a partir de la raiz sin
/api/
🔍 Ejemplos de uso
Obtener todas las entradas léxicas
GET /entries
Buscar entrada específica
GET /entries/{id}
Crear una nueva entrada
POST /entries
Content-Type: application/json
Authorization: Bearer {token}
{
"lemma_form": "babayu",
"pos_id": "nome",
"entry_type_id": "REV"
}
Editar una entrada existente
PUT /entries/{id}
Eliminar una entrada
DELETE /entries/{id}
🧠 Otros recursos disponibles
- Acepciones:
/entry-senses - Zonas dialectales:
/locations - Fenómenos lingüísticos:
/phenomenons - Fuentes documentales:
/sources - Usuarios:
/users
🧰 Consejos prácticos
- Usa Postman o Insomnia para probar endpoints de forma visual
- Consulta http://apidocs.cordia.local para ver la documentación completa
- Usa filtros y paginación (
?search=,?page=,?per_page=) cuando estén disponibles
Consulta también
api.mdyjwt.mdpara entender cómo está construida y protegida la API.