Developer Docs

Everything you need to integrate ZenFlip into your product: REST API, embed widget, webhooks, and more.

Welcome

The ZenFlip developer docs cover everything from getting started with your first publication to advanced API integrations. Choose a topic from the sidebar, or browse the sections below.

Getting Started

認証

JWTトークン、リフレッシュトークン、Google OAuthを使用したZenFlip APIの認証方法を学びます。サーバー間通信用のAPIキーも近日対応予定です。

クイックスタートガイド

5分以内にZenFlip APIを使い始めましょう。最初のAPIキーの作成、認証、パブリケーションの一覧表示を行います。

API Reference

アナリティクスAPI

ページビュー、ユニーク閲覧者数、閲覧時間、地域別内訳、デバイス統計などのアナリティクスデータを取得し、閲覧者のエンゲージメントを追跡します。

リードキャプチャAPI

リードキャプチャフォームの作成と管理、パブリケーションからの閲覧者情報の収集、リードデータのCSVエクスポートを行います。

パブリケーションAPI

フリップブックパブリケーションの作成、更新、削除、管理。PDFのアップロード、表示設定の制御、バージョン管理、QRコードの生成。

チームAPI

組織のチームメンバーを管理します。コラボレーターの招待、ロールの割り当て、権限の更新、メンバーの削除。

Embed Widget

高度な埋め込みオプション

動的埋め込み用のプログラマティックJavaScript APIの使用、React/Vue/Angular SPAとの統合、イベントハンドリング、スタイルのカスタマイズ、自動ページめくりの設定。

埋め込みウィジェットクイックスタート

1つのscriptタグでインタラクティブなフリップブックパブリケーションを任意のウェブサイトに追加できます。基本的な埋め込み方法、data属性、一般的なトラブルシューティングについて説明します。

Webhooks

Webhookイベントリファレンス

すべてのZenFlip Webhookイベントタイプの詳細なペイロードスキーマとJSON例。リクエストヘッダーとNode.js署名検証の例を含みます。

Webhook概要

ZenFlip組織でイベントが発生した際にリアルタイム通知を受け取ります。WebhookURLの登録、署名の検証、リトライの処理方法を学びます。