Getting Started
App の概念と開発の始め方
Speria プラットフォーム
Speria は、顧客と店舗スタッフ間のコミュニケーションと AI 機能を中心とした CRM プラットフォームです。外部アプリケーションから Speria のデータにアクセスしたり、Speria アカウントでユーザーログインを実現できます。
App とは
App は、Speria プラットフォームと統合する外部アプリケーションの登録単位です。1 つの App 登録で以下の機能を利用できます:
| 機能 | 説明 | 認証方式 |
|---|---|---|
| データアクセス | Workspace のデータを API 経由で取得・操作 | OAuth 2.0 + Client Credentials |
| ユーザーログイン | Speria アカウントでアプリにログイン | OIDC Implicit Flow |
データアクセスのみ、ユーザーログインのみ、または両方を利用するかは App ごとに選択できます。
主要な概念
Workspace
Workspace は Speria 上の組織単位(店舗・企業など)です。App は特定の Workspace にインストールされることで、その Workspace のデータにアクセスできるようになります。
スコープ
App がアクセスできるデータの範囲はスコープで制御されます。インストール時に Workspace の管理者がスコープを承認します。詳しくはスコープ一覧を参照してください。
App の登録
- developer.speria.jp にアクセスし、Speria アカウントでログイン
- 「App を作成」から新しい App を登録
- App の設定画面で以下の情報を確認・設定:
- client_id — 自動生成される App の識別子
- client_secret — API 認証に使用するシークレット(初回表示のみ、再表示不可)
- redirect_uris — OAuth コールバック URL
- requested_scopes — App が要求するスコープの上限
次のステップ
- 認証 — 認証方式の概要と使い分け
- API リファレンス — REST API エンドポイント一覧