Démarrage rapide

Générez votre premier document — PDF, DOCX ou SVG — en moins de 5 minutes.

1. Obtenir votre clé API

Connectez-vous à DocPayload et accédez à Paramètres > Clés API pour créer une nouvelle clé.

2. Créer une définition de document

Une définition de document est un objet JSON qui décrit votre document. La même définition s'affiche au format PDF, DOCX ou SVG — vous choisissez le format au moment de la demande.

{
  "document": {
    "metadata": {
      "title": "My First Document",
      "author": "DocPayload"
    },
    "pageSetup": {
      "size": "A4",
      "orientation": "portrait",
      "margins": [50, 40, 50, 40]
    },
    "styles": {
      "title": { "fontSize": 22, "fontWeight": "bold", "color": "#1A1A2E" },
      "body": { "fontSize": 11, "color": "#333333", "textAlign": "justified" }
    },
    "content": [
      { "p": "Hello from DocPayload!", "style": "title" },
      { "p": "This document was generated from a JSON definition using the DocPayload API. You can add [b]bold text[/b], [i]italic text[/i], [color, #0066CC]colored text[/color], tables, lists, images, barcodes, and much more.", "style": "body" }
    ]
  }
}

3. Générer un document

Ajoutez /pdf, /docx ou /svg au point de terminaison pour choisir le format de sortie. PDF est le format par défaut s'il n'est pas spécifié. Les exemples ci-dessous utilisent /pdf.

cURL

curl -X POST https://api.docpayload.com/v1/{YOUR_TENANT_ID}/documents/generate-from-payload/pdf \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d @definition.json

C#

using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");

var json = File.ReadAllText("definition.json");
var content = new StringContent(json, Encoding.UTF8, "application/json");

var response = await client.PostAsync(
    "https://api.docpayload.com/v1/{YOUR_TENANT_ID}/documents/generate-from-payload/pdf", content);

var result = await response.Content.ReadFromJsonAsync<JsonElement>();
var downloadUrl = result.GetProperty("downloadUrl").GetString();

JavaScript

const response = await fetch('https://api.docpayload.com/v1/{YOUR_TENANT_ID}/documents/generate-from-payload/pdf', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(definition),
});

const { downloadUrl } = await response.json();
window.open(downloadUrl);

Python

import requests

headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}

with open("definition.json") as f:
    response = requests.post(
        "https://api.docpayload.com/v1/{YOUR_TENANT_ID}/documents/generate-from-payload/pdf",
        headers=headers,
        data=f.read(),
    )

download_url = response.json()["downloadUrl"]

4. Ouvrir votre document

C'est tout ! Utilisez l'downloadUrl de la réponse pour télécharger ou ouvrir votre document généré.

Fonctionne avec n'importe quelle pile

Vous venez de générer un document avec une requête HTTP standard. Remplacez /pdf par /docx ou /svg pour changer de format — même définition, même appel API. Si votre pile peut envoyer du JSON avec POST, vous êtes prêt.

PHP avec curl_exec, Java avec HttpClient, Ruby avec Net::HTTP, Go avec net/http, WordPress avec wp_remote_post, systèmes hérités avec n'importe quelle bibliothèque HTTP — ils fonctionnent tous. Le code que vous venez de voir dans les exemples ci-dessus est tout ce dont vous avez besoin. Aucune bibliothèque spéciale à installer ou à mettre à jour.

Pointez votre IDE sur le Schéma JSON publié et vous obtiendrez l'autocomplétion sur chaque propriété et des soulignements rouges sur les fautes de frappe avant même de frapper l'API :

{
  "$schema": "https://docpayload.com/docs/schemas/v1/document-definition.schema.json",
  "document": { "content": [{ "p": "Hello." }] }
}

Cette ligne dans votre fichier JSON est tout ce que la plupart des éditeurs ont besoin.

Étapes suivantes

• Document Definition — Apprenez le schéma complet
• Inline Formatting — Gras, italique, couleurs, images, codes-barres
• Data Binding — Créez des modèles réutilisables avec des données dynamiques
• Playground — Essayez-le en direct dans le navigateur