API

Links in documents

Record where QR codes and link annotations sit in a document, and read its scan-to-open QR code.

A placement records that a link sits on a page of a document. A qr placement is a QR code drawn on the page and carries a qr link; an annotation is a clickable region and carries a plain link. Its rect is in PDF user space, in points from the page's bottom-left corner. The editor writes the PDF objects itself and records them here; recording or removing a placement never changes the PDF.

Removing a placement leaves the link working, because printed copies may still carry it; archive the link to stop it. Publishing a document gives it a scan-to-open QR code. Unpublishing archives that code and publishing again restores it. Recording placements needs edit access to the document. When the plan includes QR tracking, each placement carries its link's visit count so far.

Errors

Besides the errors any endpoint can answer, these endpoints answer:

StatusCodeWhen
400invalidThe objectRef or rect is not valid.
400wrong_link_kindThe existing link given is not the kind the placement carries.
400page_out_of_rangeThe page is after the current version's last page.