Documentación API

API Keys

Gestión de API Keys para acceder a la API pública (/v1). Requiere autenticación JWT.


POST /api/api-keys/

Crea una nueva API Key para el cliente actual. La clave completa solo se muestra una vez.

POST /api/api-keys/

Headers

Content-Type: application/json
Authorization: Bearer JWT_TOKEN

Body (JSON)

{"nombre": "Mi API Key Producción", "tipo": "live"}
  • nombre: (obligatorio) Nombre descriptivo de la API Key.
  • tipo: (opcional) Tipo de key: "live" (producción) o "test". Por defecto: "live".

Ejemplos

curl -X POST https://api-docmind.devol.es/api/api-keys/ \
  -H "Content-Type: application/json" -H "Authorization: Bearer JWT_TOKEN" \
  -d '{"nombre": "Mi API Key", "tipo": "live"}'

Respuesta

{
  "message": "API Key creada exitosamente",
  "api_key": {
    "id": "key-uuid",
    "nombre": "Mi API Key Producción",
    "key": "pk_live_abc123def456...",
    "tipo": "live",
    "created_at": "2025-07-24T15:30:00Z"
  }
}

Importante: El campo key solo se devuelve en la creación. Guárdalo de forma segura.

Errores

400Bad Request

Nombre faltante.

{"error": "El nombre es obligatorio"}
401Unauthorized

Token inválido.

{"msg": "Token inválido"}

GET /api/api-keys/

Lista todas las API Keys del cliente (sin mostrar la clave completa).

GET /api/api-keys/

Headers

Authorization: Bearer JWT_TOKEN

Ejemplos

curl -X GET https://api-docmind.devol.es/api/api-keys/ \
  -H "Authorization: Bearer JWT_TOKEN"

Respuesta

{
  "api_keys": [
    {
      "id": "key-uuid",
      "nombre": "Mi API Key Producción",
      "key_preview": "pk_live_abc1...f456",
      "tipo": "live",
      "created_at": "2025-07-24T15:30:00Z",
      "last_used": "2025-07-24T16:00:00Z"
    }
  ]
}

Lista de keys con solo una vista previa parcial de cada clave.

Errores

401Unauthorized

Token inválido.

{"msg": "Token inválido"}

DELETE /api/api-keys/{api_key_id}

Revoca una API Key. Una vez revocada, no se puede recuperar.

DELETE /api/api-keys/{api_key_id}

Headers

Authorization: Bearer JWT_TOKEN

Ejemplos

curl -X DELETE https://api-docmind.devol.es/api/api-keys/KEY_ID \
  -H "Authorization: Bearer JWT_TOKEN"

Respuesta

{"message": "API Key revocada exitosamente"}

La API Key se invalida inmediatamente y todas las peticiones que la usen serán rechazadas.

Errores

404Not Found

API Key no encontrada.

{"error": "API Key no encontrada"}

© 2025 Devol. Todos los derechos reservados.