スタートガイド

インストール手順と、このプラグインの完全なMarkdownガイドを含むセットアッププロンプトをコピーします。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-stripe-terminal`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/stripe-terminal/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

インストール

bun add @capgo/capacitor-stripe-terminal
bunx cap sync

インポート

import { StripeTerminal } from '@capgo/capacitor-stripe-terminal';

クイックスタート

import { StripeTerminal } from '@capgo/capacitor-stripe-terminal';

await StripeTerminal.initialize({ isTest: true });

例: discoverReaders

import { StripeTerminal, TerminalConnectTypes } from '@capgo/capacitor-stripe-terminal';

const result = await StripeTerminal.discoverReaders({ type: TerminalConnectTypes.Simulated });
// The result holds sensitive values: use it without logging it.

例: setConnectionToken

import { StripeTerminal } from '@capgo/capacitor-stripe-terminal';

await StripeTerminal.setConnectionToken({ token: 'token-123' });

よくある落とし穴

リスナー: 画面がアンマウントされたらハンドルを削除します。
一度だけ初期化: アプリの起動時にセットアップを実行します。
信頼できる情報源: 信頼 src/definitions.ts GitHub リポジトリ内。

バックエンドの要件

Stripe Terminal は、接続トークンを生成する安全なバックエンドエンドポイントが必要です。その URL を以下に渡します。 initialize().

await StripeTerminal.initialize({
  tokenProviderEndpoint: 'https://api.example.com/stripe/terminal/connection-token',
  isTest: true,
});

await StripeTerminal.discoverReaders({ type: 'tap-to-pay' });

サンプルアプリ

git clone https://github.com/Cap-go/capacitor-stripe-terminal.git
cd capacitor-stripe-terminal/example-app
bun install
bun run start

Source of Truth

このページでは、現在公開されている API について説明します。 Capgo/capacitor-stripe-terminal.