Shappi DB API
Acceso HTTP de solo lectura a la base de datos de Shappi (MySQL kargooio_app). SOLO LECTURA
Autenticación
Todas las rutas /v1/* piden la llave en el header x-api-key (o Authorization: Bearer <llave>).
Dentro de AWS e-commerce la llave está en Secrets Manager (us-east-2): shappi-db/api-key, campo api_key.
Rutas
| Ruta | Qué hace |
|---|---|
GET /health | Estado del servicio y de la conexión (sin llave). |
GET /v1/tablas | Lista de tablas con filas aproximadas. |
GET /v1/tablas/{tabla} | Columnas de una tabla (tipo, nulo, clave). |
GET /v1/tablas/{tabla}/filas | Filas de una tabla. Filtros por igualdad ?columna=valor, más limit (máx. 5000, por defecto 100), offset, orden y desc=1. |
POST /v1/consulta | SQL de lectura: {"sql": "...", "params": [...], "limit": 1000}. Solo una sentencia SELECT, WITH, SHOW, DESCRIBE o EXPLAIN. Usa ? y params para los valores. |
Respuesta
{ "columnas": ["id","status"], "filas": [{"id":"123","status":"DELIVERED"}],
"total_devuelto": 1, "truncado": false }
Números grandes y decimales llegan como texto; fechas como texto UTC (YYYY-MM-DD HH:MM:SS). Errores: {"error": "..."} con 400, 401, 403 o 404.
Ejemplos
curl -H "x-api-key: $KEY" https://db-api.shop.shappi.com/v1/tablas
curl -H "x-api-key: $KEY" "https://db-api.shop.shappi.com/v1/tablas/orders/filas?user_id=42&limit=20&orden=id&desc=1"
curl -X POST -H "x-api-key: $KEY" -H "content-type: application/json" \
-d '{"sql":"SELECT id, status FROM orders WHERE user_id = ? ORDER BY id DESC LIMIT 20","params":[42]}' \
https://db-api.shop.shappi.com/v1/consulta
// Node 18+
const r = await fetch('https://db-api.shop.shappi.com/v1/consulta', {
method: 'POST',
headers: { 'x-api-key': process.env.SHAPPI_DB_KEY, 'content-type': 'application/json' },
body: JSON.stringify({ sql: 'SELECT COUNT(*) AS n FROM orders WHERE user_id = ?', params: [42] }),
});
const { filas } = await r.json();
# Python
import requests
r = requests.post('https://db-api.shop.shappi.com/v1/consulta',
headers={'x-api-key': KEY},
json={'sql': 'SELECT id, email FROM users WHERE email = ?', 'params': ['a@b.com']}, timeout=30)
print(r.json()['filas'])
Límites
- Cada consulta corre en una transacción de solo lectura: cualquier escritura falla.
- Tiempo máximo por consulta: 15 s. Máximo 5000 filas por respuesta (
truncado: truesi había más): pagina conLIMIT/OFFSET. - No se permiten
FOR UPDATE,INTO OUTFILE,SLEEP()ni varias sentencias. - Es la base de producción: filtra siempre por índices y evita barrer tablas grandes.