¿Cómo usar la API REST de Papermark?

La API REST de Papermark te ofrece acceso programático a todos los recursos de Papermark: data rooms, documentos, carpetas, enlaces, visitantes y analíticas. Toda la interfaz funciona sobre HTTPS con JSON y un token de portador, con 43 operaciones distribuidas en seis recursos y una especificación OpenAPI que alimenta la documentación.

La API REST de Papermark está disponible en el plan Business y superiores. Las instancias de Papermark autoalojadas pueden usar la API en cualquier plan.

Qué puedes hacer con la API

Entre los seis recursos tienes 43 operaciones en total. La especificación OpenAPI completa se encuentra en /docs/openapi.json y es la base del sitio de documentación.

Paso 1: Genera un token de API

1. Inicia sesión en Papermark.
2. Ve a Configuración y luego a Tokens de API.
3. Haz clic en Crear token.
4. Selecciona los permisos (solo lectura o lectura/escritura por recurso).
5. Copia el token. Comienza con pm_live_ y actúa como credencial de portador de larga duración.

Trata el token como una contraseña. Guárdalo en tu gestor de secretos o en una variable de entorno (PAPERMARK_TOKEN).

Tokens con ámbito

Los tokens tienen ámbito definido, por lo que un agente LLM puede tener acceso de solo lectura a los documentos mientras tu trabajo de CI tiene acceso completo de escritura. Elige los ámbitos mínimos que necesita tu integración.

Paso 2: Realiza tu primera llamada

export PAPERMARK_TOKEN=pm_live_AbCdEfGhIjKlMnOpQrStUvWxYz

curl https://api.papermark.com/v1/documents \
  -H "Authorization: Bearer $PAPERMARK_TOKEN"

Recibirás una respuesta JSON con tus documentos:

{
  "data": [{ "id": "doc_pitch_v4", "name": "Pitch Deck.pdf" }],
  "next_cursor": null
}

Flujos de trabajo habituales

Crear un enlace protegido con contraseña a una sala de datos

curl -X POST https://api.papermark.com/v1/links \
  -H "Authorization: Bearer $PAPERMARK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "dataroom_id": "dr_8K2m",
    "password": "series-b-2026",
    "expires_at": "2026-06-10T00:00:00Z",
    "email_gate": true,
    "allow_download": false
  }'

La respuesta incluye la URL del enlace único lista para compartir.

Obtener analíticas página a página para una vista

curl https://api.papermark.com/v1/view-analytics/vw_3m9k \
  -H "Authorization: Bearer $PAPERMARK_TOKEN"

Devuelve un payload con pages_viewed, completed, duration_ms, top_page y un array de page_durations_ms.

Subir un documento (archivos grandes)

Para archivos de más de 10 MB, utiliza el flujo de carga prefirmada de S3:

1. Solicita una URL de carga: POST /v1/documents/upload-url
2. Sube el archivo directamente a S3 con la URL prefirmada devuelta
3. Confirma la carga: POST /v1/documents/confirm

No se requieren complicaciones de streaming en tu código.

Autenticación y límites de velocidad

• Autenticación mediante token Bearer: cabecera Authorization: Bearer pm_live_... en cada solicitud
• Solo HTTPS: las solicitudes por HTTP son rechazadas
• Claves de idempotencia: incluye Idempotency-Key: <uuid> para reintentos seguros en solicitudes POST
• Paginación: los endpoints de listado utilizan paginación por cursor con next_cursor para navegar por los resultados
• Límites de velocidad: se aplican límites estándar según el plan; contacta con soporte si tu integración necesita límites más altos

Especificación OpenAPI y SDKs

La especificación completa está disponible en /docs/openapi.json. Puedes generar clientes en cualquier lenguaje con herramientas como openapi-typescript, openapi-python-client o openapi-generator.

openapi-typescript https://api.papermark.com/docs/openapi.json -o papermark.d.ts

Para Node.js, hay un SDK publicado en npm:

npm install papermark

import { Papermark } from "papermark";

const pm = new Papermark({ apiKey: process.env.PAPERMARK_TOKEN });
const { data } = await pm.documents.list();

Webhooks para eventos en tiempo real

La API te proporciona acceso de consulta. Para recibir eventos push (enlace visualizado, documento subido, enlace creado), utiliza los webhooks. Se complementan muy bien con la API para integraciones basadas en eventos.

Casos de uso

• Sincronización con CRM: cuando un nuevo visitante abre un enlace, registra automáticamente el contacto en HubSpot o Salesforce.
• Captación de inversores: genera programáticamente enlaces personalizados para cada inversor y envíaselos por correo electrónico.
• Paneles de informes: exporta datos de visitantes y análisis a tu almacén de datos o herramienta de BI.
• Aprovisionamiento automatizado de data rooms: crea un data room con una estructura de carpetas desde un job de CI.
• Agentes de IA: combina la API con el servidor MCP para que agentes como Claude puedan actuar sobre los recursos de Papermark.

Preguntas frecuentes

Guías relacionadas

• Cómo usar el CLI de Papermark
• Cómo usar el servidor MCP de Papermark
• Cómo crear webhooks en Papermark
• Seguridad de código abierto

¿Necesitas ayuda? Contacta con support@papermark.com o usa el chat integrado en la aplicación.