SMAPIで開発を始める
Alexaスキル管理API(SMAPI)は、Alexaスキル管理タスクをプログラムで実行できるRESTful HTTPインターフェースを提供します。スキル管理タスクには、スキルの新規作成や対話モデルの更新などがあります。APIは、Login with Amazonを使用して呼び出し元を認証します。認証された開発者はすべて、ユーザーに代わってAlexaスキルの作成や更新を行うツールやサービスの開発ができるようになります。ASK CLIは、そうしたツールの1つです。
スキル管理APIの認証スキームは、開発者がAPIアクセス権限をツールやサービスに委譲する用途に最適化されています。
Alexaスキル管理API
APIに統合するツールやサービスを独自に開発している場合、Login with AmazonにOAuth 2.0を統合する必要があります。ユーザーの認可をリクエストしたり、スキル管理APIの呼び出しに使用するアクセストークンを取得したりするには、このOAuth 2.0を使用します。APIにはauthorization code
Grant種別が必要です。アクセストークンの取得方法と、ツールがリクエストできるOAuthスコープの詳細については、SMAPIで使用するアクセストークンの取得方法を参照してください。
APIエンドポイント
このAPIのルートエンドポイントは、https://api.amazonalexa.com
です。Login with Amazonから取得したアクセストークンを、各REST APIリクエストのAuthorization
ヘッダーに指定する必要があります。
スキル管理用REST API
以下のSMAPI REST APIを使用して、スキルに関する操作を実行できます。
- Alexa-hostedスキル管理
- インテントリクエスト履歴
- 対話モデルカタログ管理
- 対話モデル管理
- ロケール複製
- レポート
- リソーススキーマ
- スキル認定
- スキルの認証情報
- スキルの有効化
- スキルの呼び出し
- スキルマニフェスト
- スキルメッセージ
- スキルパッケージ管理
- スキル公開
- スキルロールバック
- スキルシミュレーション
- スキル検証
- 発話競合検出APIリファレンス
- 発話プロファイラーREST APIリファレンス
- ベンダー管理
スキルテスト用REST API
以下のSMAPI REST APIを使用して、スキルをプログラムでテストできます。
- 自然言語理解アノテーションセット
- 自然言語理解評価
- 発話プロファイラー - ユーザーの発話をテストしてスキルの対話モデルを改善します。
- スキル呼び出し - テスト目的でスキルを呼び出します。
- スキルシミュレーション - テスト目的でスキルコードをシミュレートします。
- スキル検証 - スキル認定を申請する前や開発中の見直しテストとして随時、スキルを検証します。
- ベータテスト管理 - Alexaスキルの本番リリース前に、限られたユーザーを対象にスキルのベータテストを設定します。
- ベータテスター管理 - Alexaスキルのベータテストに参加者を招待します。
オブジェクトスキーマ
AlexaスキルをASK CLIまたはSMAPIで管理する場合、各リソースはJSON形式で表記する必要があります。
詳細については、以下のリファレンスを参照してください。
SMAPI SDK
SMAPIはNode.js、Python、JavaのSMAPI SDKでも使うことができます。SMAPI SDKを用いて任意のスキル管理APIを呼び出すことで、スキルをプログラムで管理できます。使用方法については、以下のリファレンスを参照してください。
関連トピック
最終更新日: 2023 年 05 月 15 日