L'adresse contre laquelle les liens se lisent
Dire où le document a été publié, pour que ses liens courts continuent de mener au bon endroit après un déplacement.
Écrit au premier niveau d'une requête, sous
"base_uri"
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.
Dans un document, un lien peut être écrit en abrégé : « conditions.html », sans le début de l'adresse. Tant que le fichier reste à côté de cette page, tout va bien. Le jour où quelqu'un le télécharge et l'ouvre chez lui, l'abréviation ne mène plus nulle part. On règle ça en écrivant une fois, dans le document, l'adresse complète de l'endroit d'où il vient. Les abréviations se lisent alors depuis là, où que le fichier se trouve.
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.
base_uri déclare l'adresse contre laquelle les liens relatifs du document se résolvent. Un lien vers terms.html ne veut rien dire tant que le document n'a pas dit où il a été publié ; c'est cette déclaration qui garde de tels liens vivants une fois le fichier déplacé. Les liens absolus, eux, mènent où ils disent, quoi qu'il arrive.
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.
-
base_uri— chaîne, facultative, absente par défaut. L'adresse complète contre laquelle les adresses relatives du document se lisent, par exemplehttps://hqf-pdf.com/en/handbook/.
Elle vaut pour toutes les adresses relatives que le document porte : celles d'un élément link avec {"uri": "..."}, et celles d'une action uri. Une adresse absolue reste lue telle quelle.
Une requête entière qui le dessine
Envoyez ceci tel quel et un PDF revient. Rien n'en a été retiré.
{
"base_uri": "https://hqf-pdf.com/en/handbook/",
"standard_fonts": [{ "name": "sans", "face": "helvetica" }],
"items": [
{
"type": "text",
"rect": { "llx": 60, "lly": 740, "urx": 535, "ury": 758 },
"content": ["Read the terms"],
"font": "sans",
"font_size": 12
},
{
"type": "link",
"rect": { "llx": 60, "lly": 738, "urx": 160, "ury": 760 },
"to": { "uri": "terms.html" }
}
]
}
Le document dans son ensemble
Les numéros que le lecteur affiche Cent courriers dans un seul fichier Ce que le document dit de lui-même Un fichier lisible dans trente ans Une facture qu'un humain et une machine lisent La version de PDF que le fichier déclare Ce qu'une image dit d'elle-même
Où aller ensuite
Chaque clé d'une requête, en une page Les trente-deux autres réglages d'une requête