Générer des PDF à partir de modèles Word en Ruby

Avec DocuGenerate, vous pouvez créer des documents PDF et Word directement depuis votre application Ruby. Ce guide montre comment appeler chaque méthode de l’API depuis Ruby 3.0 ou une version ultérieure. Pour la liste complète des paramètres et des réponses, consultez la référence de l’API.

Sommaire

1. Authentification
2. Créer un modèle
3. Lister les modèles
4. Récupérer un modèle
5. Mettre à jour un modèle
6. Supprimer un modèle
7. Générer un document
8. Lister les documents
9. Récupérer un document
10. Mettre à jour un document
11. Supprimer un document

1. Authentification

Chaque requête est authentifiée en envoyant votre clé API dans l’en-tête Authorization. Stockez la clé dans une variable d’environnement plutôt que de l’écrire en dur dans votre code source :

export DOCUGENERATE_API_KEY="YOUR-API-KEY"

Les exemples utilisent net/http et json de la bibliothèque standard de Ruby, il n’y a donc rien à installer. Ils partagent tous les require et les constantes suivants. Comme net/http ne lève pas d’exception sur les statuts d’erreur HTTP, chaque exemple vérifie la réponse avant de la lire :

require 'net/http'
require 'json'

API_URL = 'https://api.docugenerate.com/v1'
API_KEY = ENV['DOCUGENERATE_API_KEY']

Si votre compte stocke ses données dans une autre région, remplacez l’URL de base par l’endpoint régional correspondant, par exemple https://api.eu.docugenerate.com/v1.

2. Créer un modèle

Pour créer un modèle, envoyez le fichier du modèle avec une requête POST /template. Cet endpoint exige le type de contenu multipart/form-data, que set_form définit automatiquement, avec le séparateur multipart :

uri = URI("#{API_URL}/template")
request = Net::HTTP::Post.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'

File.open('Business Letter.docx') do |file|
  request.set_form(
    [
      ['file', file],
      ['name', 'Business Letter']
    ],
    'multipart/form-data'
  )
  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

  unless response.is_a?(Net::HTTPSuccess)
    raise "DocuGenerate API error #{response.code}: #{response.body}"
  end

  template = JSON.parse(response.body)
  puts template['id']
end

Ne définissez pas l’en-tête Content-Type vous-même, sinon le séparateur est absent et la requête échoue. La réponse contient le nouveau modèle, y compris les tags détectés automatiquement dans le fichier :

{
  "enhanced_syntax": false,
  "versioning_enabled": false,
  "folder": [],
  "tags": {
    "valid": [
      "Date",
      "Name",
      "Job Title",
      "Company Name",
      "Street Address",
      "City",
      "State",
      "Zip Code",
      "Email",
      "Phone"
    ],
    "invalid": []
  },
  "created": 1791055374301,
  "updated": 1791055374301,
  "name": "Business Letter",
  "delimiters": {
    "left": "[",
    "right": "]"
  },
  "filename": "Business Letter.docx",
  "format": ".docx",
  "region": "eu",
  "page_count": 1,
  "image_uri": "https://firebasestorage.googleapis.com/v0/b/storage.eu.docugenerate.com/o/templates%2FuVE30i1427KQsYcED0bl%2FBusiness%20Letter.png?alt=media&token=0ce64a4b-495a-426b-8783-42b479f7ae38",
  "preview_uri": "https://firebasestorage.googleapis.com/v0/b/storage.eu.docugenerate.com/o/templates%2FuVE30i1427KQsYcED0bl%2FBusiness%20Letter.pdf?alt=media&token=0b3939c7-824e-4979-9aca-ca4a87175cbf",
  "template_uri": "https://firebasestorage.googleapis.com/v0/b/storage.eu.docugenerate.com/o/templates%2FuVE30i1427KQsYcED0bl%2FBusiness%20Letter.docx?alt=media&token=d37a4458-3620-48db-94b8-6ac46f0442ab",
  "id": "uVE30i1427KQsYcED0bl"
}

Conservez l’id du modèle, car vous en aurez besoin pour générer des documents. Les paramètres facultatifs suivants peuvent aussi être ajoutés au formulaire :

delimiters : Les délimiteurs utilisés pour détecter les balises, envoyés sous forme de chaîne JSON, par exemple { left: '[', right: ']' }.to_json. Par défaut, ils sont déterminés automatiquement.
region : Où sont stockés le modèle et ses documents générés, soit us, eu, uk ou au. Si aucune région n’est indiquée, celle du compte est utilisée.
enhanced_syntax : Définissez sur 'true' pour utiliser des propriétés imbriquées et des opérateurs logiques ou mathématiques dans les balises.
versioning_enabled : Définissez sur 'true' pour conserver les versions précédentes du fichier lors de l’envoi d’un nouveau, si votre forfait le permet.
folder : Le dossier du modèle, de la racine jusqu’au dernier niveau. Les dossiers manquants sont créés automatiquement.

Pour placer le modèle dans un dossier, ajoutez un champ folder pour chaque niveau du chemin. Par exemple, pour le placer dans le dossier Letters > Business :

request.set_form(
  [
    ['file', file],
    ['name', 'Business Letter'],
    ['folder', 'Letters'],
    ['folder', 'Business']
  ],
  'multipart/form-data'
)

3. Lister les modèles

Une requête GET /template renvoie tous les modèles de votre compte :

uri = URI("#{API_URL}/template")
request = Net::HTTP::Get.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

templates = JSON.parse(response.body)
templates.each do |template|
  puts "#{template['id']} #{template['name']}"
end

Pour lister uniquement les modèles d’un dossier, répétez le paramètre de requête folder pour chaque niveau du chemin. Par exemple, pour lister les modèles du dossier Letters > Business :

uri = URI("#{API_URL}/template")
uri.query = URI.encode_www_form(
  [
    ['folder', 'Letters'],
    ['folder', 'Business']
  ]
)

request = Net::HTTP::Get.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

Seuls les modèles placés directement dans ce dossier sont renvoyés. Les modèles de ses sous-dossiers ne sont pas inclus. Pour en savoir plus, découvrez comment organiser les modèles dans des dossiers avec l’API.

4. Récupérer un modèle

Pour récupérer un seul modèle, appelez GET /template/{id} avec son ID :

template_id = 'bet2oQirk0pSd9ctH9Qu'

uri = URI("#{API_URL}/template/#{template_id}")
request = Net::HTTP::Get.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

template = JSON.parse(response.body)
puts template['tags']['valid']

C’est utile, par exemple, pour vérifier quelles balises de fusion le modèle attend avant de générer des documents.

5. Mettre à jour un modèle

Une requête PUT /template/{id} met à jour un modèle. Tous les paramètres sont facultatifs, n’envoyez donc que ceux que vous souhaitez modifier. Par exemple, pour envoyer une nouvelle version du fichier et renommer le modèle :

template_id = 'bet2oQirk0pSd9ctH9Qu'

uri = URI("#{API_URL}/template/#{template_id}")
request = Net::HTTP::Put.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'

File.open('Business Letter v2.docx') do |file|
  request.set_form(
    [
      ['file', file],
      ['name', 'Business Letter v2']
    ],
    'multipart/form-data'
  )
  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

  unless response.is_a?(Net::HTTPSuccess)
    raise "DocuGenerate API error #{response.code}: #{response.body}"
  end

  template = JSON.parse(response.body)
end

Comme pour la création d’un modèle, le corps doit être en multipart/form-data, que set_form définit automatiquement, avec le séparateur multipart. En plus de file et name, les paramètres facultatifs suivants peuvent être ajoutés au formulaire :

delimiters : Les nouveaux délimiteurs, envoyés sous forme de chaîne JSON. S’ils sont fournis, le modèle est à nouveau analysé pour détecter les balises de fusion selon les nouveaux délimiteurs. Lorsqu’un nouveau file est envoyé sans delimiters, les délimiteurs actuels sont utilisés.
region : Déplace le modèle vers une autre région, soit us, eu, uk ou au. Les documents générés ensuite sont stockés dans la nouvelle région, tandis que les documents existants restent dans leur région actuelle.
folder : Déplace le modèle vers un autre dossier, avec un champ folder pour chaque niveau du chemin. Envoyez '[]' pour sortir le modèle de tout dossier.
enhanced_syntax : Définissez sur 'true' ou 'false' pour activer ou désactiver la syntaxe avancée.
versioning_enabled : Définissez sur 'true' ou 'false' pour activer ou désactiver l’historique des versions, si votre forfait le permet.

6. Supprimer un modèle

Pour supprimer un modèle, envoyez une requête DELETE /template/{id}. L’API répond avec un statut 204 No Content en cas de succès :

template_id = 'bet2oQirk0pSd9ctH9Qu'

uri = URI("#{API_URL}/template/#{template_id}")
request = Net::HTTP::Delete.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

7. Générer un document

Vous générez des documents avec une requête POST /document, en transmettant le template_id et le paramètre data, utilisé pour remplacer les balises de fusion :

uri = URI("#{API_URL}/document")
request = Net::HTTP::Post.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'
request['Content-Type'] = 'application/json'
request.body = {
  'template_id' => 'bet2oQirk0pSd9ctH9Qu',
  'data' => {
    'Date' => 'October 4, 2026',
    'Name' => 'Emily Carter',
    'Job Title' => 'Operations Manager',
    'Company Name' => 'Harbor Point Consulting',
    'Street Address' => '118 West Street',
    'City' => 'Annapolis',
    'State' => 'Maryland',
    'Zip Code' => '21405',
    'Email' => 'emily.carter@example.com',
    'Phone' => '(410) 555-0142'
  },
  'output_format' => '.pdf'
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

document = JSON.parse(response.body)
puts document['document_uri']

La réponse contient les propriétés du document :

{
  "created": 1791125416372,
  "template_id": "bet2oQirk0pSd9ctH9Qu",
  "name": "Business Letter",
  "format": ".pdf",
  "data_length": 1,
  "filename": "Business Letter.pdf",
  "document_uri": "https://firebasestorage.googleapis.com/v0/b/storage.us.docugenerate.com/o/documents%2FiESelthRt4uaYQRTemrL%2FBusiness%20Letter.pdf?alt=media&token=c4b259ec-249b-4b35-a62f-6a8dc0da75f3",
  "id": "iESelthRt4uaYQRTemrL"
}

Le paramètre output_format peut valoir .docx (par défaut), .pdf, .doc, .odt, .txt, .html, .png ou une version PDF/A. Vous pouvez aussi fusionner des fichiers PDF à la fin du document généré avec merge_with, ou ajouter des pièces jointes avec attach.

Télécharger le fichier
Le champ document_uri pointe vers le fichier généré, que vous pouvez télécharger et enregistrer sur le disque :

file = Net::HTTP.get_response(URI(document['document_uri']))

unless file.is_a?(Net::HTTPSuccess)
  raise "Download failed with status #{file.code}"
end

File.binwrite(document['filename'], file.body)

Recevoir le fichier directement
Si vous ne voulez pas que le document soit stocké dans le cloud, définissez l’en-tête Accept sur application/octet-stream. L’API renvoie alors le fichier binaire au lieu du JSON :

uri = URI("#{API_URL}/document")
request = Net::HTTP::Post.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/octet-stream'
request['Content-Type'] = 'application/json'
request.body = {
  'template_id' => 'bet2oQirk0pSd9ctH9Qu',
  'data' => {
    'Date' => 'October 4, 2026',
    'Name' => 'Emily Carter',
    'Job Title' => 'Operations Manager',
    'Company Name' => 'Harbor Point Consulting',
    'Street Address' => '118 West Street',
    'City' => 'Annapolis',
    'State' => 'Maryland',
    'Zip Code' => '21405',
    'Email' => 'emily.carter@example.com',
    'Phone' => '(410) 555-0142'
  },
  'output_format' => '.pdf'
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

File.binwrite('Business Letter.pdf', response.body)
puts response['X-Document-Id']

Génération de documents par lot
Pour générer plusieurs documents en une seule requête, passez un tableau de hashes dans data. Un document est généré pour chaque hash :

uri = URI("#{API_URL}/document")
request = Net::HTTP::Post.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'
request['Content-Type'] = 'application/json'
request.body = {
  'template_id' => 'bet2oQirk0pSd9ctH9Qu',
  'data' => [
    { 'Date' => 'October 4, 2026', 'Name' => 'Emily Carter', 'Job Title' => 'Operations Manager', 'Company Name' => 'Harbor Point Consulting', 'Street Address' => '118 West Street', 'City' => 'Annapolis', 'State' => 'Maryland', 'Zip Code' => '21405', 'Email' => 'emily.carter@example.com', 'Phone' => '(410) 555-0142' },
    { 'Date' => 'October 4, 2026', 'Name' => 'Daniel Brooks', 'Job Title' => 'Logistics Coordinator', 'Company Name' => 'Northfield Logistics', 'Street Address' => '2400 South Lamar Boulevard', 'City' => 'Austin', 'State' => 'Texas', 'Zip Code' => '78704', 'Email' => 'daniel.brooks@example.com', 'Phone' => '(512) 555-0187' }
  ],
  'output_format' => '.pdf',
  'single_file' => true,
  'page_break' => true
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

document = JSON.parse(response.body)

Par défaut, tous les documents sont combinés dans un seul fichier, avec un saut de page après chacun d’eux. Définissez page_break sur false pour supprimer les sauts de page.

Lorsque single_file vaut false, un fichier est généré par objet de données et tous les fichiers sont regroupés dans une archive .zip. Utilisez le paramètre name pour nommer l’archive, et output_name avec des balises de fusion pour donner à chaque fichier un nom dynamique, comme Letter for [Name] :

request.body = {
  'template_id' => 'bet2oQirk0pSd9ctH9Qu',
  'data' => [...],
  'output_format' => '.pdf',
  'single_file' => false,
  'name' => 'Business Letters',
  'output_name' => 'Letter for [Name]'
}.to_json

Cela génère une archive Business Letters.zip contenant Letter for Emily Carter.pdf et Letter for Daniel Brooks.pdf. Les balises de fusion de output_name doivent utiliser les mêmes délimiteurs que le modèle.

Utiliser un fichier de données
Pour générer des documents en masse à partir d’un fichier Excel ou CSV, envoyez le fichier dans une requête multipart/form-data. Un document est généré pour chaque ligne de la feuille de calcul. Si le fichier contient plusieurs feuilles, indiquez le paramètre sheet pour choisir celle à utiliser.

uri = URI("#{API_URL}/document")
request = Net::HTTP::Post.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'

File.open('Data.xlsx') do |file|
  request.set_form(
    [
      ['template_id', 'bet2oQirk0pSd9ctH9Qu'],
      ['file', file],
      ['output_format', '.pdf']
    ],
    'multipart/form-data'
  )
  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

  unless response.is_a?(Net::HTTPSuccess)
    raise "DocuGenerate API error #{response.code}: #{response.body}"
  end
end

L’utilisation d’un fichier de données est une autre forme de génération par lot, donc les mêmes paramètres s’appliquent pour combiner les documents générés dans un seul fichier ou les regrouper dans une archive .zip avec un nom personnalisé pour chaque fichier.

8. Lister les documents

Une requête GET /document renvoie les documents générés à partir d’un modèle, dont l’ID est passé dans le paramètre de requête template_id :

uri = URI("#{API_URL}/document")
uri.query = URI.encode_www_form(template_id: 'bet2oQirk0pSd9ctH9Qu')

request = Net::HTTP::Get.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

documents = JSON.parse(response.body)
documents.each do |document|
  puts "#{document['id']} #{document['name']} #{document['document_uri']}"
end

9. Récupérer un document

Pour récupérer un seul document, appelez GET /document/{id} avec son ID :

document_id = 'iESelthRt4uaYQRTemrL'

uri = URI("#{API_URL}/document/#{document_id}")
request = Net::HTTP::Get.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

document = JSON.parse(response.body)

10. Mettre à jour un document

Une requête PUT /document/{id} renomme un document, le nom étant la seule propriété modifiable :

document_id = 'iESelthRt4uaYQRTemrL'

uri = URI("#{API_URL}/document/#{document_id}")
request = Net::HTTP::Put.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'
request['Content-Type'] = 'application/json'
request.body = { 'name' => 'Letter for Emily Carter' }.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

document = JSON.parse(response.body)

11. Supprimer un document

Pour supprimer un document, envoyez une requête DELETE /document/{id}. L’API répond avec un statut 204 No Content en cas de succès :

document_id = 'iESelthRt4uaYQRTemrL'

uri = URI("#{API_URL}/document/#{document_id}")
request = Net::HTTP::Delete.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

🆕 Ruby SDK

Modèles

Documents

Intégrations

Développeurs

Compte

SDK API