Descripción general de la API

La API de DocMap proporciona endpoints REST para extraer datos estructurados de documentos PDF utilizando plantillas impulsadas por IA.

URL base

Todas las solicitudes a la API se realizan a:

https://api.docmap.io

Todos los endpoints versionados están prefijados con /v1/.

Autenticación

Todos los endpoints /v1/* requieren un encabezado Authorization con un token Bearer. Puedes usar una clave API o un token de Firebase ID:

Authorization: Bearer dm_live_abc123def456ghi789jkl012mno345

Las claves API se pueden crear y gestionar desde Panel de control > Configuración > Claves API o mediante los endpoints de claves API. Consulta la guía de autenticación para más detalles.

Tipo de contenido

Todos los cuerpos de solicitud y respuesta usan JSON:

Content-Type: application/json

Límites de uso

Las solicitudes de extracción están sujetas a límites mensuales según tu plan. Usa el endpoint GET /v1/usage para consultar tu consumo actual. Consulta la guía de límites de uso para las cuotas por plan.

Resumen de endpoints

Método	Ruta	Descripción
GET	/health	Verificación de salud (sin autenticación)
POST	/v1/extractions/run	Ejecutar una extracción en un documento PDF
GET	/v1/extractions	Listar registros de extracción
DELETE	/v1/extractions/{id}	Eliminar un registro de extracción
GET	/v1/usage	Obtener el uso actual del período de facturación
POST	/v1/api-keys	Crear una nueva clave API
GET	/v1/api-keys	Listar todas las claves API activas
DELETE	/v1/api-keys/{id}	Revocar una clave API

Verificación de salud

GET /health es el único endpoint sin autenticación. Úsalo para verificar que la API está accesible.

curl

curl https://api.docmap.io/health

TypeScript

const res = await fetch('https://api.docmap.io/health')
const data = await res.json()
console.log(data) // { status: "ok" }

Python

import requests

res = requests.get("https://api.docmap.io/health")
print(res.json())  # {"status": "ok"}

Respuesta:

{ "status": "ok" }

Formato de errores

Todas las respuestas de error siguen una estructura consistente:

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or expired API key."
  }
}

Consulta la referencia de códigos de error para ver la lista completa de códigos de error y sus significados.

Especificación OpenAPI

La especificación OpenAPI completa está disponible para herramientas y generación de clientes:

• OpenAPI JSON: https://api.docmap.io/openapi.json
• Swagger UI: https://api.docmap.io/docs