Wie verwendet man die Papermark REST API?

Die Papermark REST API bietet dir programmatischen Zugriff auf alle Papermark-Ressourcen: Datenräume, Dokumente, Ordner, Links, Besucher und Analysen. Die gesamte Oberfläche basiert auf HTTPS, JSON und einem Bearer-Token – mit 43 Operationen über sechs Ressourcen und einer OpenAPI-Spezifikation, die die Dokumentation antreibt.

Die Papermark REST API ist im Business-Plan und höher verfügbar. Selbst gehostete Papermark-Instanzen können die API in jedem Plan nutzen.

Was du mit der API machen kannst

Über die sechs Ressourcen hinweg stehen dir insgesamt 43 Operationen zur Verfügung. Die vollständige OpenAPI-Spezifikation liegt unter /docs/openapi.json und treibt die Dokumentationsseite an.

Schritt 1: Einen API-Token generieren

1. Melde dich bei Papermark an.
2. Gehe zu Einstellungen und dann zu API-Tokens.
3. Klicke auf Token erstellen.
4. Wähle Berechtigungen (nur lesen oder lesen/schreiben pro Ressource).
5. Kopiere den Token. Er beginnt mit pm_live_ und fungiert als langlebiges Bearer-Credential.

Behandle das Token wie ein Passwort. Speichere es in deinem Secrets Manager oder als Umgebungsvariable (PAPERMARK_TOKEN).

Begrenzte Token

Token sind auf bestimmte Berechtigungen beschränkt, sodass ein LLM-Agent nur Lesezugriff auf Dokumente haben kann, während dein CI-Job vollen Schreibzugriff besitzt. Wähle die minimalen Berechtigungen, die deine Integration benötigt.

Schritt 2: Deinen ersten Aufruf machen

export PAPERMARK_TOKEN=pm_live_AbCdEfGhIjKlMnOpQrStUvWxYz

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

Du erhältst eine JSON-Antwort mit deinen Dokumenten:

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

Häufige Workflows

Einen passwortgeschützten Link zu einem Datenraum erstellen

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
  }'

Die Antwort enthält die eindeutige Link-URL, die sofort geteilt werden kann.

Seitenweise Analysen für eine Ansicht abrufen

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

Gibt ein Payload zurück mit pages_viewed, completed, duration_ms, top_page und einem Array von page_durations_ms.

Ein Dokument hochladen (große Dateien)

Für Dateien über 10 MB verwende den S3-Presigned-Upload-Flow:

1. Eine Upload-URL anfordern: POST /v1/documents/upload-url
2. Die Datei direkt mit der zurückgegebenen Presigned URL zu S3 hochladen
3. Den Upload bestätigen: POST /v1/documents/confirm

Kein kompliziertes Streaming in deinem Code erforderlich.

Authentifizierung und Ratenlimits

• Bearer-Token-Authentifizierung: Authorization: Bearer pm_live_... Header bei jeder Anfrage
• Nur HTTPS: Anfragen über HTTP werden abgelehnt
• Idempotenzschlüssel: Idempotency-Key: <uuid> für sichere Wiederholungsversuche bei POST-Anfragen übergeben
• Paginierung: Listenendpunkte verwenden Cursor-Paginierung mit next_cursor zum Durchblättern der Ergebnisse
• Ratenlimits: Standardlimits gelten je nach Tarif; kontaktiere den Support, wenn deine Integration höhere Limits benötigt

OpenAPI-Spezifikation und SDKs

Die vollständige Spezifikation ist unter /docs/openapi.json verfügbar. Du kannst Clients in jeder Sprache mit Tools wie openapi-typescript, openapi-python-client oder openapi-generator generieren.

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

Für Node.js ist ein SDK auf npm veröffentlicht:

npm install papermark

import { Papermark } from "papermark";

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

Webhooks für Echtzeit-Ereignisse

Die API gibt dir Pull-Zugriff. Für Push-Ereignisse (Link aufgerufen, Dokument hochgeladen, Link erstellt) nutze Webhooks. Sie ergänzen die API ideal für ereignisgesteuerte Integrationen.

Anwendungsfälle

• CRM-Synchronisierung: Wenn ein neuer Betrachter einen Link öffnet, wird ein Datensatz in HubSpot oder Salesforce übertragen.
• Investor-Outreach: Personalisierte Links für jeden Investor programmatisch erstellen und per E-Mail versenden.
• Reporting-Dashboards: Besucher- und Analysedaten in dein Data Warehouse oder BI-Tool übertragen.
• Automatisierte Datenraum-Bereitstellung: Einen Datenraum mit einer Ordnerstruktur aus einem CI-Job aufsetzen.
• KI-Agenten: Die API mit dem MCP-Server kombinieren, damit Agenten wie Claude auf Papermark-Ressourcen zugreifen können.

Häufig gestellte Fragen

Verwandte Anleitungen

• So verwendest du die Papermark CLI
• So verwendest du den Papermark MCP-Server
• So erstellst du Webhooks in Papermark
• Open-Source-Sicherheit

Benötigst du Hilfe? Kontaktiere support@papermark.com oder nutze den In-App-Chat.