ウェブサイトを作成したりホストしたりするツールを作っていますか? Connect Notiamo ボタンを追加しましょう。ユーザーがボタンをクリックし、Notiamoにログイン(または登録)して、許可をクリックします。Notiamoはそのウェブサイト用のプロジェクトを作成し、ウィジェットコードをあなたのツールに渡します。ツールはそのコードをウェブサイトに追加するか、コピーできるように表示します。

得られるもの

  • ユーザーは、あなたのツールから離れずにウェブサイトのフィードバックを集められます。
  • あなたのボタンから来た顧客ごとに、その顧客が最初の12か月に支払う額(税抜き)の20%を報酬として受け取れます。月に1回、報酬が50 EUR以上になると明細書を作成します。あなたが請求書を送ると、銀行振込、PayPal、Wiseのうちお好きな方法でお支払いします。支払い手数料は方法と銀行によって異なり、あなたの負担となります。支払い先の情報は 設定 › 紹介プログラム で追加します。パートナープログラムのルールが適用されます。Notiamoの有料プランは不要で、年間の上限もありません。
  • あなたのツールが、ユーザーのコメントや他のプロジェクトを見ることはありません。受け取るのは1つだけ、新しいプロジェクトのウィジェットコードです。

1. パートナーになる

お問い合わせページから、次の内容を送ってください。

  • ツールの名前とそのウェブサイト
  • ボタンを表示するツールのページ(正確なアドレス。例:https://app.builder.example)
  • あなたのNotiamoの組織(明細書と支払い先の情報はここにあります。無料アカウントで十分です)

こちらから app id をお送りします。それをボタンに入れてください。

2. ボタンを追加する

スクリプトを一度読み込み、app idとユーザーが作っているウェブサイトのアドレスを付けたボタンを追加します。

<script src="https://my.notiamo.com/connect/v1.js" defer></script>

<button data-notiamo-connect
        data-client="YOUR_APP_ID"
        data-site="https://shop.example"
        data-name="Shop">
  Connect Notiamo
</button>

成功すると、ボタンはウィジェットコード付きの notiamo:connected イベントを送ります。

const button = document.querySelector("[data-notiamo-connect]");
button.addEventListener("notiamo:connected", (event) => {
  const { snippet, projectId } = event.detail;
  saveToTheHead(snippet); // your tool puts it in the website's <head>
});
button.addEventListener("notiamo:cancelled", () => { /* the user closed the window or clicked Deny */ });
button.addEventListener("notiamo:error", (event) => console.error(event.detail.message));

ツールがウェブサイトのコードを変更できない場合は、data-mode="copy" を追加してください。Notiamoが小さなウィンドウにコードを表示し、コピーボタンを付けます。

3. またはコードから呼び出す

const result = await Notiamo.connect({
  clientId: "YOUR_APP_ID",
  site: "https://shop.example",
  name: "Shop",          // optional: the project name, else the website's address
  mode: "return",        // or "copy"
});
if (result.status === "connected") {
  // result.snippet, result.projectId, result.publicKey, result.dashboardUrl
}

Notiamo.connect() はクリックの中で呼び出してください。後から開くウィンドウはブラウザにブロックされます。

ユーザーに表示される内容

  1. Notiamoの小さなウィンドウが開きます。
  2. ログインしていない場合は、メールアドレスを入力します。ログインリンクは別のタブで開きます。ウィンドウはそれに気づき、自動で先に進みます。新しいユーザーは同じウィンドウで登録します。
  3. 許可ページには、あなたのツールがそのウェブサイトにNotiamoを追加しようとしていると表示されます。ユーザーは組織とワークスペースを選び、許可(または拒否)をクリックします。
  4. ウィンドウが閉じます。あなたのページがウィジェットコードを受け取ります。

プランの上限はダッシュボードと同じように適用されます。新しい無料アカウントには、すでにプロジェクトが1つあります。Notiamoは2つ目を作らず、そのプロジェクトをこのウェブサイトに使います。

セキュリティ

  • この方法でプロジェクトを作成できるのはパートナーアプリだけです。コードを受け取れるのは、あなたが伝えたページだけです。ウィンドウはその正確なアドレスにだけコードを送り、ほかには送りません。
  • スクリプトはクリックごとにPKCEとランダムな state を使います。アクセスは読み取り専用で、新しいプロジェクト1つだけに限られ、スクリプトがウィジェットコードを読み取るとすぐに終わります。
  • Notiamoのページはフレームの中では決して読み込まれません。そのため、ボタンはウィンドウを開きます。

サーバー側のツール

ツールが自分のサーバーで処理を終える場合は、そのリダイレクトアドレスも送ってください。ユーザーを https://my.notiamo.com/oauth/authorize に送ります。その際、response_type=code、client_id としてapp id、redirect_uri、PKCEの code_challenge(S256)、state、connect_site(ウェブサイト)を付けます。https://my.notiamo.com/api/oauth/token でコードを交換し、アクセストークンで GET https://my.notiamo.com/api/connect/project を読み取ります。応答には snippet、projectId、publicKey、site、dashboardUrl が含まれます。

質問

お問い合わせページからご連絡ください。公開前に、ボタンのテストをお手伝いします。