Foliade
Turn PDFs into mobile flipbook catalogues: upload private drafts, customise, publish, get stats.
- 1.2.0
- Version
- remote
- Transport
- 35
- Tools
Security review
Review passedReviewed 1d ago.
- tools: 35 tools scanned
- metadata: scanned
No findings.
Tools (35)
foliade_account
Confirms the address and the plan of the destination account, without secrets or payment data.
foliade_list_catalogues
Lists the private and public catalogues of the connected account, with pagination.
foliade_prepare_upload
Creates a single-use 10-minute deposit. Compute the size and the SHA-256 of the local PDF. Transfer the bytes to upload_url with PUT, Content-Type application/pdf, with the headers returned. Do not publish these headers in your reply. This ticket allows no reading and is not an API key for the account.
foliade_import_url
Fetches a PDF that is already online and prepares it as a private draft. Use this when the user gives a link, or when your host hands you an attachment as a download URL rather than a local file. For a file on the user's machine, use foliade_prepare_upload instead. Only public https links are accepted, and the server checks that the link really returns a PDF. Call foliade_finalize_upload next with the upload_id.
foliade_finalize_upload
Finalises an upload that has been received. A repeat returns the same catalogue, never a duplicate. Conversion is asynchronous: check foliade_catalogue_status before giving the final result. The catalogue stays private until it is published explicitly.
foliade_catalogue_status
Private state: owner OAuth or guest token, never the public link alone.
foliade_publish_catalogue
Makes the catalogue public, on explicit request only. Keeps its identifier. It does not change the password or the addresses: those belong to foliade_set_catalogue_access.
foliade_catalogue_stats
Aggregated statistics: reads and contacts, without disclosing the contact details.
foliade_unpublish_catalogue
Closes the public link without deleting the data. Requires an explicit request.
foliade_capabilities
Effective entitlements, JSON schemas and examples. Read before configuring; omitted fields are kept, null is refused. Setting changes are visible immediately on a published catalogue. Binary media, PDF replacements, API keys, REST webhooks, team and billing stay in the workspace/API.
foliade_get_catalogue_settings
Settings, table of contents, lead capture, protection without secrets, and the revision needed for changes.
foliade_update_catalogue
Changes only the fields supplied: colours, bar, controls, sound, reading, logo, title, language, PDF. It never touches the table of contents, which belongs to foliade_set_chapters. dry_run returns a preview without writing. No change to the publication state.
foliade_set_catalogue_access
Changes access on explicit request only. Never publishes a draft. The password is never returned. This tool sets the password and the addresses; to make a draft public, use foliade_publish_catalogue. Declaring a domain does not configure DNS/TLS; activation remains a separate operation.
foliade_set_lead_capture
Sets activation, page, blocking mode, fields and consent. A plan with lead capture is required; email is mandatory.
foliade_set_chapters
Replaces the table of contents with the ordered list supplied; an empty list removes it. Only the table of contents: every other reader setting stays with foliade_update_catalogue.
foliade_import_chapters
Merges the PDF bookmarks into the table of contents without duplicates.
foliade_get_brand
Brand name, colour and default PDF download; without any billing information.
foliade_update_brand
Account-wide impact: use it when a global customisation is asked for, prefer update_catalogue for a single PDF.
foliade_list_themes
Account themes, their settings and revisions; a theme is a copy, not a live link.
foliade_create_theme
Saves the existing styling and media of the catalogue as a theme, within the limit of the plan.
foliade_update_theme
Changes the theme for its future applications. make_default changes the starting point of new catalogues.
foliade_apply_theme
Copies the styling and media of a theme of this account onto this catalogue.
foliade_get_enrichments
Elements, published version, differences and revision. The files remain those of the catalogue.
foliade_update_enrichments
Replaces the draft: 13 types, links, buttons, videos, forms, products, galleries, tours, questions. No element that is invalid or closed off by the plan is accepted. Nothing is published before publish_enrichments. See capabilities and get_enrichments for the examples and the native structure.
foliade_publish_enrichments
Publishes the interactive elements explicitly, with history. Does not publish the catalogue itself.
foliade_restore_enrichments
Restores a version of this catalogue after re-checking the plan; creates a new history entry.
foliade_list_shelves
Paginated list of the shelves and their settings, without passwords.
foliade_get_shelf
Settings, catalogues in order, and revision of the shelf.
foliade_create_shelf
Creates a shelf as a draft. The Distributeur plan is required; nothing is published automatically.
foliade_update_shelf
Texts, six layouts, covers, shelf boards, colours, fonts, collections, search and opening.
foliade_set_shelf_catalogues
Replaces the contents of the shelf with this ordered list with collection names. The PDFs themselves are kept.
foliade_set_shelf_access
Publication and access of the shelf on explicit request only; DNS/TLS remain separate.
foliade_list_tracking_links
Named links of the catalogue owned by the account. Contains the recipients; do not disclose them publicly.
foliade_create_tracking_link
Creates a named Business link. No email is sent; does not publish the catalogue.
foliade_update_tracking_link
Changes recipient, note, email or active flag; closing is explicit and reversible, with no message sent.