Le papier à en-tête sous les pages

En mots de tous les jours

Écrit pour tout le monde. Il dit ce que cela pose sur une feuille de papier, et ne vous demande rien de plus.

Beaucoup d'entreprises ont du papier à en-tête : le logo en haut, l'adresse en bas, et un grand blanc au milieu pour écrire. Ici c'est la même chose, en numérique. On fournit une fois le fond, déjà fabriqué, et le texte vient se poser dessus. On peut même en fournir trois : un pour la première page, un pour les pages du milieu, un pour la dernière — la page de signature, par exemple.

Pour un développeur

Écrit pour celui qui écrit le programme appelant : le modèle, les unités, et les réglages qui portent le poids.

templates nomme jusqu'à trois PDF de fond, par position de page : le début, le milieu, la fin. Les octets de chaque fond arrivent à côté de la requête, dans une partie du formulaire portant exactement ce nom. Le fond du milieu tient sur une seule page, qui se répète autant de fois qu'il le faut ; les fonds de début et de fin peuvent en compter plusieurs. Les trois clés sont facultatives : une requête peut n'en donner qu'une.

Chaque clé, avec son défaut

La référence : quelles clés sont obligatoires, lesquelles sont facultatives, ce que vaut chacune par défaut et quelles combinaisons le serveur décline.

templates — objet, facultatif, absent par défaut.
templates.start — chaîne, facultative. Le nom de la partie fournie portant le gabarit posé sous les premières pages du document.
templates.middle — chaîne, facultative. Le nom de la partie portant le gabarit d'une seule page, posé sous les pages entre la première et la dernière. Un gabarit de plusieurs pages est refusé ici.
templates.end — chaîne, facultative. Le nom de la partie portant le gabarit posé sous les dernières pages.

Chaque nom désigne une partie du corps multipart/form-data, à côté de json_data. Un nom qu'aucune partie ne porte est refusé. Une page importée d'un autre document en cours de page se fait par un élément pdf_page, qui puise dans le même vivier de parties fournies.

Une requête entière qui le dessine

Envoyez ceci tel quel et un PDF revient. Rien n'en a été retiré.

{
  "templates": { "start": "letterhead" },
  "standard_fonts": [{ "name": "sans", "face": "helvetica" }],
  "items": [
    {
      "type": "text",
      "rect": { "llx": 60, "lly": 640, "urx": 535, "ury": 700 },
      "content": ["Dear Madam,\nThank you for your order of 4 August."],
      "font": "sans",
      "font_size": 11,
      "leading": 15
    }
  ]
}

La ligne qui l'envoie, en trois langages

La feuille, et ce qu'on pose dessous

La taille des pages Une taille propre à certaines pages Les zones que la page déclare L'orientation à l'écran et à l'impression

Où aller ensuite

Chaque clé d'une requête, en une page Les trente-deux autres réglages d'une requête

Voir les prix Voir les exemples

Glossaire

octet: L'unité dans laquelle se compte le poids d'un fichier, comme un colis se compte en grammes. Mille octets font un kilo-octet, un million font un méga-octet — la taille d'une photo prise avec un téléphone. Un PDF d'une page pèse ici entre six mille et cent vingt mille, donc cent PDF tiennent dans la place de cinq photos.
signature: Un cachet posé à l'intérieur du document. Il prouve deux choses d'un coup : qui l'a approuvé, et que rien n'y a changé depuis. Le logiciel qui ouvre le fichier l'annonce dans un bandeau, en haut de la page.
requête: Un appel au service : vous envoyez ce que le document doit dire, et vous recevez le document. Votre facture compte ces appels, un par document. Le nombre de pages d'un document n'est jamais compté.
formulaire multipart: Une façon d'emballer plusieurs choses dans un seul appel : chacune reçoit un nom et voyage dans sa propre partie, et ce peut être du texte comme des fichiers. C'est ce qu'emploie une page web pour envoyer une photographie, et ce qui porte la description d'un document à côté des images qu'il dessine.

Tous les mots que le site explique