Public spaces, guests and anonymous visitors

Show API docs to guests and to anonymous visitors of public Confluence spaces, and share a snapshot on public links.

Apifolio works for guests and for anonymous visitors of spaces that allow anonymous access, as well as for licensed users.

Readers' browsers normally read the spec file themselves, as the reader. Anonymous visitors, and guests whose browser can't read the file, get it from the app instead, with two safety rules:

  • the file must be attached to the same page as the macro (the visitor can already see that page and its attachments);
  • files up to about 4 MB are served this way (a little less for YAML full of quotes or backslashes, which take twice the room on the way). Larger specs need a signed-in reader.

A macro that shows a spec from another page works for signed-in readers who can view both pages, but not for anonymous visitors. Signed-in readers who can't open the source page see its title and an Open source page button, so they can ask for access.

The macro dialog warns editors when anonymous visitors won't see a macro: for files on another page, for files larger than 4 MB, and for smaller files that would still be too large to send.

Confluence public links (sharing one page with anyone on the internet) don't display content from Marketplace apps, including Apifolio. To share API docs on a public link:

  • In the macro, choose ⋯ → Copy as Confluence content, then paste it into the page, under the macro or on a child page. It becomes native headings, tables and code blocks that public links, the page's table of contents and Confluence search can see. It follows the macro's filters.
  • Or export the page to PDF.

Copy as Confluence content is a dated snapshot: it starts with a line such as "Snapshot of Payments API 2.4.0, 2026-10-07" and doesn't change when the file changes. Copy it again after an update. It is available while the site's Apifolio subscription is active.

View as Markdown