Developer & Publisher Hub

Editorial3D Documentation

Everything you need to turn PDFs into engaging 3D flipbooks, embed viewers into your apps, configure custom domains, and capture leads.

Quickstart Guide

Get your first 3D interactive flipbook published in less than 3 minutes without any design or 3D modeling expertise.

1 Upload your PDF

Log in to your Editorial3D dashboard and click New Publication. Drag and drop any standard PDF file up to 50MB. Our backend extracts high-resolution page texture layers automatically.

2 Customize the Viewer

In the Studio Editor, preview your publication in real-time. Select your background canvas skin (Charcoal, Deep Blue, Warm Wood, or Crisp Studio), set your publication title, and adjust flip physics.

3 Publish & Share

Hit Publish. You will receive an instant link (e.g. https://app.editorial3d.com/#/view/your-catalog or on your custom domain) ready to share with clients or embed on your website.

PDF File Guidelines

For the crispest text rendering and smoothest 60 FPS page-turn animations, follow these document recommendations:

  • Page Aspect Ratio: Consistent page dimensions throughout the PDF produce the cleanest double-page spreads.
  • Resolution: 150 to 300 DPI is optimal. Our engine generates multi-tier mipmap tiles so mobile readers load instantly without downloading heavy full-resolution textures.
  • File Size: Files up to 50MB are supported directly. If your document exceeds 50MB, compress embedded raster images using Adobe Acrobat or Ghostscript before uploading.

Viewer Controls & Physics

The Editorial3D engine simulates realistic paper weight, lighting, page curl, and shadows rendered in WebGL:

  • Page Turning: Click or drag page corners, swipe on touchscreens, or use the Left/Right keyboard arrow keys.
  • Zoom: Double-click any region or click the Zoom tool to inspect small text and high-res schematics.
  • Thumbnail Bar: Jump directly to any page spread using the interactive thumbnail drawer.
  • Sound Effects: Subtle paper-curl audio plays during flips (can be muted by readers or disabled by default).

Configuring Lead Capture Gates

Turn casual readers into qualified inbound leads by gating full access to your publication:

  • Gate Position: Choose which page triggers the email gate (e.g., allow readers to preview pages 1 and 2 for free, and gate page 3).
  • Form Fields: Collect Email address, Full Name, Company, or Phone Number.
  • Custom Messaging: Customize your call-to-action title, description, and button text (e.g. "Enter your work email to view the complete catalog").

Custom Domains & SSL

Publish flipbooks under your own brand's subdomain (e.g., catalog.yourcompany.com):

  1. In your Editorial3D Dashboard, navigate to White-Label → Custom Domains.
  2. Enter your desired subdomain (e.g., read.yourbrand.com).
  3. In your DNS provider (Cloudflare, GoDaddy, Namecheap, Route 53), add a CNAME record:
    Type: CNAME
    Name: read
    Value: cname.editorial3d.com
  4. Click Verify DNS in your dashboard. Our system confirms propagation and issues a dedicated SSL certificate within minutes.

White-Label & Custom SMTP

Growth and Scale tier accounts have full white-label capabilities:

  • Branding Removal: Remove the Editorial3D watermark and logo from the viewer footer and toolbar.
  • Custom Logo: Upload your own SVG or PNG brand logo to appear in the viewer header.
  • Customer SMTP: Connect your company's SendGrid, Mailgun, Amazon SES, or Google Workspace SMTP server to send lead download links from hello@yourbrand.com.

Website Embed Code

Embed your interactive flipbook into any HTML page, WordPress site, Webflow project, or Shopify store.

Responsive Iframe Snippet

<iframe
  src="https://app.editorial3d.com/#/view/your-publication-slug"
  width="100%"
  height="600"
  frameborder="0"
  allowfullscreen
  allow="fullscreen"
></iframe>

Deep Linking to Specific Pages

You can link readers directly to a specific page spread using the ?page=N query parameter:

https://app.editorial3d.com/#/view/your-slug?page=12

Webhooks & API Integration

Send real-time event payloads to your CRM (HubSpot, Salesforce, Zapier, Make) whenever a lead is captured or reader milestones are reached.

Sample Webhook Payload (lead.captured)

{
  "event": "lead.captured",
  "timestamp": "2026-09-17T14:30:00Z",
  "publicationId": "pub_98a72b",
  "publicationTitle": "Q3 Wholesale Catalog",
  "lead": {
    "email": "sarah.connor@acme.com",
    "name": "Sarah Connor",
    "capturedOnPage": 3
  }
}

HMAC-SHA256 Signature Verification (Node.js)

const crypto = require('crypto');

function verifyEditorial3DWebhook(rawBody, signatureHeader, secret) {
  const hash = crypto.createHmac('sha256', secret).update(rawBody).digest('hex');
  return crypto.timingSafeEqual(Buffer.from(hash), Buffer.from(signatureHeader));
}

Views & Top-Up Quotas

Your plan includes a monthly view allowance that resets on the 1st of each calendar month. Views are counted when a unique visitor loads your flipbook.

If you reach 100% of your monthly view quota, active publications remain live without interruption. You can purchase top-up view packs (+5,000 views for $10) at any time from your dashboard.