appkit ダッシュボードへ
連携ガイド

ミスなく導入 — あなた自身でも、AI エージェントでも。

AppKit ができること、それぞれがどこに表示されるか、そしてコーディングアシスタントに貼るだけの prompt。やり方が分からない部分は、エージェントが代わりにやってくれます。

01AI エージェント向けの prompt

下のテキストをコーディングアシスタントに貼り付け、MINHA_CHAVE_PK_LIVE をダッシュボードのキーに置き換えてください。インストール、空状態、ステップ完了まで、プロダクトを壊さずに連携全体をやってくれます。

Claude Code Antigravity OpenAI / Codex Cursor, Copilot…
prompt-appkit.txt
あなたは私のコーディングアシスタントです。AppKit(appkit.com.br)を私の Web プロダクトに、何も壊さずに組み込んでください。AppKit は外部ダッシュボードから制御される onboarding チェックリスト・空状態・お知らせを注入します。正確に次を実行してください:

1) インストール
- プロジェクトが bundler(React/Vue/Next/Svelte など)を使う場合:このパッケージをインストールする
  @tecaless/appkit-sdk
  そしてエントリーポイントで、ユーザーのログイン後(id が取得できた時点で)に次を呼び出す:
  import { init } from '@tecaless/appkit-sdk'
  init({ apiKey: 'MINHA_CHAVE_PK_LIVE', userId: <ログイン中ユーザーの安定した id> })
- 静的サイト / no-code の場合: の前に追加する:
  
- userId/data-user は必ずログイン中ユーザーの安定した識別子にすること。AppKit はサーバー側でそれを hash 化する — メールアドレスや氏名は絶対に送らない。ログイン中ユーザーがいなければ userId は付けない。

2) 空状態
データなしで始まり、行動への誘導を出したい画面(例:請求書、連絡先、カレンダー)ごとに、現在の空状態をマーク付きコンテナ 1 つで包み、既存の内容は fallback として中に残す:
  
...既存の「レコードなし」の内容...
画面ごとに短く安定した名前を使う(例:faturas-vazio、contatos-vazio)。ビルド生成の CSS セレクターは使わない。作成した名前の一覧を私に返すこと。 3) ステップ完了(実メトリクスのために重要) ユーザーの実際の行動を表す onboarding ステップ(例:「最初の請求書を発行」)ごとに、行動が本当に確定したまさにその瞬間に呼び出す — ボタンクリック時ではなく、サーバーへの保存後に: window.AppKit && window.AppKit.track('fatura_emitida') アクションごとに snake_case のイベント名を 1 つ使う。作成したイベントの一覧を私に返すこと。 4) 何も壊さない - SDK は非同期で読み込む。フェイルオープンなので(落ちても勝手に消えるだけで、私のプロダクトには影響しない)。 - pk_live キーは本来パブリックなもの(クライアントに置いてよい)。秘密キーは一切公開しない。 - AppKit を待ってレンダリングをブロックしない。 最後に一覧を出す:(a) 変更したファイル、(b) 作成した data-appkit 名、(c) 作成したイベント名 — 私が AppKit ダッシュボードで設定できるように。
エージェントの作業が終わったら、返してくれた data-appkit 名イベント名を使って、ダッシュボードで空状態とステップ完了を設定してください。

02インストール

方法は 2 つ。フレームワークを使っているなら npm から始めてください。

bundler を使う場合(React、Vue、Next、Svelte…)— 推奨

terminal
npm i @tecaless/appkit-sdk
app.js — ログイン後
import { init, track } from '@tecaless/appkit-sdk'

init({ apiKey: 'MINHA_CHAVE_PK_LIVE', userId: usuario.id })
// 実際のアクションが起きたとき:
track('fatura_emitida')

No-code / 静的サイト — 1 行だけ

</body> の前
<script src="https://appkit.com.br/sdk/appkit@3.0.7.js"
        data-key="MINHA_CHAVE_PK_LIVE"
        data-user="ID_DO_USUARIO" async></script>

pk_live_… キーはダッシュボードのインストールにあります。本来パブリックなキーです(設定の読み取りとイベント送信しかできません)。

03それぞれの表示場所

3 つのエクスペリエンスは、インストールしたドメイン内であればプロダクトのどのページでも動きます。すべてダッシュボードから制御でき、再 deploy は不要です。

yoursystem.com/invoices AppKit のお知らせ — 上部でコンテンツを押し下げる · ユーザー視点で見る 空状態(data-appkit) 「ここには何もありません」の代わりに行動への誘導 はじめの一歩 完了したステップ 次のステップ

チェックリスト

隅に浮かぶカード。どのページにも表示され、ユーザーがすべて完了すると自動的に消えます。

お知らせ

コンテンツを押し下げる上部バナー(重ならない)。リンクを付けられます。いつでも公開・取り下げできます。

空状態

プロダクトが「レコードなし」と表示する場所 — コードに触れる必要はありません(エージェントが対応)。行動への誘導に変わります。

04空状態:コードに触れる必要はありません

空状態のマジックは、何も宣言しなくていいことです。Prompt をコピーをクリックすれば、AI エージェントが技術的な部分を引き受けます。システムに既にある要素をセレクター経由で指すか(HTML には触れません)、必要なら安定したマーカーを追加します — AppKit はどちらも受け付けます。あとはダッシュボードから文言を編集するだけ。ずっと、deploy なしで。

アンカーがいつか消えても、AppKit が通知し(appkit_anchor_missing イベント)、何もレンダリングしません — 画面は通常のままです。

05ステップはどう完了するか

3 つのモードを、ダッシュボードでステップごとに選べます。これで、アクティベーションファネルが実際の行動を測るのか、単なるクリックを測るのかが決まります。

真実

イベントで

あなたのコードが、実際のアクションの瞬間に AppKit.track('acao') を呼びます。偽装できません — トラクション指標として使えるのはこれです。

proxy

ルートで

ユーザーがあるルートに到達します(例:/faturas/nova)。実際のシグナルですが、「到達」は「実行」ではありません。

なくてもよい

手動

ユーザーが項目をクリックしてチェックします。情報系のステップ(「これを読んで」)向け。意図的に偽装可能です。

トラクション分析を意味あるものにするには、重要なステップはイベントで完了させるべきです。手動だと、測っているのは「ユーザーが完了をクリックした」であって「ユーザーが実行した」ではありません。

06保証

07よくあるミス(と回避方法)

Widget が表示されない

data-key と、エクスペリエンスがダッシュボードで公開済み(下書きではなく)かを確認してください。

空状態が表示されない

HTML に data-appkit="…" がないか、ダッシュボードの名前がコード内の名前と一致していません。

ステップが自動で完了しない

「ルートで」ルールなのにルートが空、または「イベントで」なのに適切なタイミングでコードに track() がありません。

ユーザー名が表示されてしまう

エクスペリエンスのタイトルや data-user に氏名/メールアドレスを入れないでください — 安定した id を使ってください。

まだ疑問がありますか? contato@appkit.com.br まで。