導入ガイド Guide

導入前に確認できる公開ガイド

PiyoENQは、PHPが使えるサーバーへ設置して使うシンプルなアンケートフォームツールです。
このページでは、動作環境・導入の流れ・設置イメージ・埋め込み方法など、導入前に確認しておきたい内容をまとめています。


目次

  1. PiyoENQとは
  2. 向いているケース
  3. 動作環境
  4. 導入の流れ
  5. 設置イメージ
  6. 最低限の設定
  7. 埋め込み方法
  8. よくある質問

1. PiyoENQとは

PiyoENQは、既存サイトにアンケートフォームを追加できる軽量なフォームツールです。
データベースを使わず、アンケート定義・回答・集計データをJSONファイルで管理します。

管理画面でフォームを作成し、発行された埋め込みコードを公開ページへ貼り付けることで、既存サイト上にアンケートフォームを表示できます。

2. このような場合に向いています

社内アンケートや簡易調査を行いたい

満足度調査、意見収集、簡単なヒアリングなど、複数のフォームを必要に応じて作成・管理できます。

既存サイトにフォームだけ追加したい

サイト全体を作り替えず、必要なページにアンケートフォームだけを後から埋め込めます。

データベースを使わずに運用したい

MySQLなどを用意せず、PHPとファイル書き込み権限がある環境で導入できます。

3. 動作環境

必須要件

  • PHP 7.4以上
  • JSONファイルへの書き込みが可能なサーバー環境
  • data/ 配下への書き込み権限があること
  • フォームを表示する公開ページでJavaScriptが利用できること

推奨環境

  • Apache(同梱の .htaccess を利用できる環境)
  • PHP 8.x
  • HTTPS環境

補足

  • データベースは不要です
  • 共有サーバーでも、PHPと書き込み権限が利用できれば動作する場合があります
  • nginx等では、data/ 配下を直接公開しないための設定が別途必要です
  • 別ドメインのページへ埋め込む場合は、許可Originの設定が必要です
購入前に一番確認したいのは、「PHPが動くか」「data/ に書き込めるか」「data/ が外部公開されないか」です。

4. 導入の流れ

  1. ファイルをアップロードする
    PiyoENQ本体をサーバーへ配置します。通常は /piyoenq/ のようなディレクトリに設置します。
  2. 初期設定を行う
    ブラウザからPiyoENQへアクセスし、サイト名、設置パス、管理ユーザー、許可Originなどを設定します。
  3. フォームを作成する
    管理画面でアンケートを作成し、設問タイプ、質問文、選択肢、公開状態、公開期間などを設定します。
  4. 公開ページへ埋め込む
    編集画面に表示される埋め込みコードを、フォームを表示したいページへ貼り付けます。
  5. 回答と集計を確認する
    送信された回答は集計画面で確認でき、必要に応じてCSV形式でダウンロードできます。

5. 設置イメージ

PiyoENQでは、「PiyoENQ本体」と「フォームを表示する公開ページ」を分けて考えます。
PiyoENQ本体には管理画面・API・埋め込みJavaScriptが含まれ、公開ページ側には埋め込みコードを貼り付けます。

/piyoenq/   ← PiyoENQ本体(管理画面・API・埋め込みJS)
/contact/   ← フォームを表示する公開ページ

たとえば /piyoenq/ にPiyoENQを設置し、既存サイトの /contact//survey/ などにフォームを埋め込む構成です。

6. 最低限の設定

導入時に特に重要なのは、site_pathsite_urlallowed_origins の考え方です。

site_path

PiyoENQ本体を設置したURLパスです。
例:ルート直下なら //piyoenq/ に置くなら /piyoenq/
ここが間違っていると、管理画面のCSSやJavaScript、APIの参照先が正しく動作しません。

site_url

PiyoENQ本体を設置しているサイトのURLです。
設定すると、埋め込みコード内のスクリプトURLなどを絶対URLとして扱いやすくなります。

allowed_origins

別ドメインの公開ページからPiyoENQのAPIを利用する場合に、許可するOriginを指定します。
同一サイト内に設置する場合は、通常は追加設定なしで利用できます。

購入後には、より詳しいインストール手順と設定例を同梱しています。

7. 埋め込み方法

埋め込みコード方式

アンケート編集画面に表示される埋め込みコードを、公開ページの表示したい位置に貼り付けます。

<div class="piyo-enq-embed" data-embed-key="enq_xxxxx"></div>
<script src="/piyoenq/js/piyo-enq-embed.js" defer></script>
上記は site_path/piyoenq/ の場合の例です。
data-embed-key により、表示するアンケートが特定されます。
複数のアンケートを設置する場合は、それぞれ異なる埋め込みキーを使用します。

APIを利用した独自実装

フォーム定義や集計データはJSON APIでも取得できます。必要に応じて、独自のJavaScript実装から利用できます。

/piyoenq/api/form.php?embed_key=enq_xxxxx
/piyoenq/api/submit.php
/piyoenq/api/summary.php?survey_id=survey_xxxxx
通常の利用では、管理画面で発行される埋め込みコードを使用する方法が簡単です。
別ドメインからAPIを利用する場合は、許可Originの設定をご確認ください。

8. よくある質問

難しいですか?

基本的な導入は、サーバーへファイルを配置し、ブラウザ上で初期設定を行えば進められます。
ただし、PHPが利用できること、data/ に書き込めること、data/ が外部公開されないことは事前に確認が必要です。

データベースは必要ですか?

不要です。アンケート定義・回答データ・集計データはJSONファイルで管理されます。

既存サイトに使えますか?

はい。既存のHTMLサイトへ埋め込みコードを貼り付けることで、フォームを後から追加できます。

公開ページはPHPでなくても使えますか?

はい。埋め込み先のページはHTMLでも利用できます。フォーム表示と送信にはJavaScriptを使用します。

複数のフォームを管理できますか?

はい。複数のアンケートフォームを作成でき、フォームごとに設問・回答・集計を管理できます。

回答データは確認できますか?

集計画面で設問ごとの結果を確認できます。回答データはCSV形式でダウンロードできます。

別ドメインのサイトにも埋め込めますか?

可能です。その場合は、PiyoENQの設定で埋め込み先サイトのOriginを許可してください。
例:https://example.com


より詳しい手順は購入後にご利用いただけます

インストール手順や使い方ガイド、管理画面内ヘルプなど、実際の運用に必要な資料を同梱しています。
導入を進める際は、これらを参照しながら設定いただけます。