Comment utiliser l'API REST Papermark ?

L'API REST Papermark vous offre un accès programmatique à toutes les ressources Papermark : data rooms, documents, dossiers, liens, visiteurs et analyses. L'ensemble repose sur HTTPS, JSON et un token Bearer, avec 43 opérations réparties sur six ressources et une spécification OpenAPI qui alimente la documentation.

L'API REST Papermark est disponible à partir du plan Business. Les instances Papermark auto-hébergées peuvent utiliser l'API sur n'importe quel plan.

Ce que vous pouvez faire avec l'API

Les six ressources totalisent 43 opérations. La spécification OpenAPI complète est disponible à l'adresse /docs/openapi.json et alimente le site de documentation.

Étape 1 : Générer un token API

1. Connectez-vous à Papermark.
2. Accédez à Paramètres, puis Tokens API.
3. Cliquez sur Créer un token.
4. Sélectionnez les périmètres d'accès (lecture seule ou lecture/écriture par ressource).
5. Copiez le token. Il commence par pm_live_ et constitue un identifiant Bearer à longue durée de vie.

Traitez ce jeton comme un mot de passe. Stockez-le dans votre gestionnaire de secrets ou en variable d'environnement (PAPERMARK_TOKEN).

Jetons à portée limitée

Les jetons sont à portée limitée : un agent LLM peut avoir un accès en lecture seule aux documents, tandis que votre tâche CI bénéficie d'un accès complet en écriture. Choisissez les portées minimales dont votre intégration a besoin.

Étape 2 : Effectuez votre premier appel

export PAPERMARK_TOKEN=pm_live_AbCdEfGhIjKlMnOpQrStUvWxYz

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

Vous recevrez une réponse JSON avec vos documents :

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

Workflows courants

Créer un lien protégé par mot de passe vers une data room

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 réponse inclut l'URL du lien unique, prête à être partagée.

Récupérer les analyses page par page pour une vue

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

Renvoie un payload contenant pages_viewed, completed, duration_ms, top_page, ainsi qu'un tableau de page_durations_ms.

Téléverser un document (fichiers volumineux)

Pour les fichiers de plus de 10 Mo, utilisez le flux de téléversement S3 avec URL présignée :

1. Demandez une URL de téléversement : POST /v1/documents/upload-url
2. Téléversez le fichier directement vers S3 avec l'URL présignée retournée
3. Confirmez le téléversement : POST /v1/documents/confirm

Aucune gymnastique de streaming requise dans votre code.

Authentification et limites de débit

• Authentification par jeton Bearer : en-tête Authorization: Bearer pm_live_... sur chaque requête
• HTTPS uniquement : les requêtes HTTP sont rejetées
• Clés d'idempotence : transmettez Idempotency-Key: <uuid> pour des nouvelles tentatives sécurisées sur les requêtes POST
• Pagination : les endpoints de liste utilisent la pagination par curseur avec next_cursor pour parcourir les résultats
• Limites de débit : des limites standard s'appliquent selon votre plan ; contactez le support si votre intégration nécessite des limites plus élevées

Spécification OpenAPI et SDK

La spécification complète est disponible à l'adresse /docs/openapi.json. Vous pouvez générer des clients dans n'importe quel langage avec des outils tels que openapi-typescript, openapi-python-client ou openapi-generator.

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

Pour Node.js, un SDK est publié sur npm :

npm install papermark

import { Papermark } from "papermark";

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

Webhooks pour les événements en temps réel

L'API vous donne un accès en mode pull. Pour recevoir des événements en push (lien consulté, document téléversé, lien créé), utilisez les webhooks. Ils fonctionnent très bien avec l'API pour des intégrations orientées événements.

Cas d'utilisation

• Synchronisation CRM : lorsqu'un nouveau visiteur ouvre un lien, poussez un enregistrement dans HubSpot ou Salesforce.
• Démarchage investisseurs : générez automatiquement des liens personnalisés pour chaque investisseur et envoyez-les par e-mail.
• Tableaux de bord de reporting : importez les données de visiteurs et d'analyse dans votre entrepôt de données ou votre outil de BI.
• Provisionnement automatisé de data rooms : créez une data room avec une structure de dossiers à partir d'un job CI.
• Agents IA : combinez l'API avec le serveur MCP pour permettre à des agents comme Claude d'agir sur les ressources Papermark.

Foire aux questions

Guides associés

• Comment utiliser le CLI Papermark
• Comment utiliser le serveur MCP Papermark
• Comment créer des webhooks dans Papermark
• Sécurité open source

Besoin d'aide ? Contactez support@papermark.com ou utilisez le chat intégré à l'application.