SMAPIで開発を始める



スキル管理APIの概要

Alexaスキル管理API(SMAPI)は、Alexaスキル管理タスクをプログラムで実行できるRESTful HTTPインターフェースを提供します。スキル管理タスクには、スキルの新規作成や対話モデルの更新などがあります。APIは、Login with Amazonを使用して呼び出し元を認証します。認証された開発者はすべて、ユーザーに代わってAlexaスキルの作成や更新を行うツールやサービスの開発ができるようになります。ASK CLIは、そうしたツールの1つです。

スキル管理APIの認証スキームは、開発者がAPIアクセス権限をツールやサービスに委譲する用途に最適化されています。

SMAPI(スキル管理API)を使用して、多くのスキルに関する操作を実行できます。次のようなことができます。

Alexaスキル管理API

APIに統合するツールやサービスを独自に開発している場合、Login with AmazonにOAuth 2.0を統合する必要があります。ユーザーの認可をリクエストしたり、スキル管理APIの呼び出しに使用するアクセストークンを取得したりするには、このOAuth 2.0を使用します。詳細については、Login With Amazon開発者ガイドを参照してください。APIでは、authorization code Grant種別を使用する必要があります。アプリケーションでリクエストできるOAuthのスコープと関連する権限は以下のとおりです。

サードパーティ製ツールはすべて、Login With Amazon Services Agreement(英語)に同意する必要があります。

スコープ 権限
alexa::ask:skills:read Amazon開発者アカウントに関連付けられたベンダーIDのリストの表示
スキル詳細の読み取り(対話モデルを除く)。スキルステータスの取得スキルリストの取得
alexa::ask:skills:readwrite alexa::ask:skills:readのすべてのアクセス権限
スキルの作成
スキルの更新
スキルの有効化
スキルのアカウントリンクの読み取りおよび更新、スキルの申請と取り下げ
alexa::ask:models:read 対話モデルの読み取り
対話モデルのビルドステータスの取得
alexa::ask:models:readwrite alexa::ask:models:readのすべてのアクセス権限
対話モデルの更新
alexa::ask:skills:test スキルのテスト:スキルの呼び出し、シミュレーションリクエストの送信、シミュレーションステータスの取得

APIのルートエンドポイントはhttps://api.amazonalexa.comです。以下の各API操作に表示されるパスはrootに続けて記述する必要があります。Login with Amazonから取得したアクセストークンは、各リクエストのAuthorizationヘッダーに格納されます。

オブジェクトスキーマ

AlexaスキルをASK CLIまたはSMAPIで管理する場合、各リソースをJSON形式で表記する必要があります。

関連トピック: