Alexaスキルの認証情報API

Alexaスキルの資格情報API

Alexaスキルの資格情報APIは、クライアントの資格情報を返します。具体的には、スキルのclientIdとclientSecretです。これらの資格情報は、ユーザーの認証トークンを取得するために使用できます。認証トークンは、スキルメッセージAPIからアクセストークンを取得するために使用します。

ワークフローは次のようになります。

スキルのサービスコードがLWAを呼び出してアクセストークンを取得します。
その後、このトークンはSMAPI APIの呼び出しを認可するために使用されます。
SMAPI APIの呼び出しが認可されると、特定のskillIdに対するクライアント資格情報が返されます。応答には、skillMessagingCredentialsが含まれます。これは、スキルが承認された権限にアクセスできるようにするために使われる、ユーザー認証トークンの取得に使用されます。

このAPIのエンドポイントは、https://api.amazonalexa.comです。すべてのAPIリクエストにはAuthorizationヘッダーが必要であり、その値はLogin with Amazonから取得したアクセストークンでなければなりません。

GET

指定したスキルのスキル資格情報を取得します。

HTTP/1.1

GET /v1/skills/{skillId}/credentials

フィールド	説明	パラメーターの型	必須
skillId	一意のスキルIDです。	文字列	〇

  Content-Type: application/json
  Accept: application/json
  Authorization: string

本文は空です。

Content-Type: application/json
X-Amzn-RequestId: string
X-Amzn-Authorization: string

{
  "skillMessagingCredentials": {
    "clientId": "<String>",
    "clientSecret": "<String>"
  }
}

フィールド	説明
clientId	クライアントの一意のIDです。
clientSecret	アプリケーションと認可サーバーにのみ伝えられる文字列です。

ステータス	コード	説明
401	Unauthorized	ユーザーまたはリクエスターには、スキルの資格情報取得が認可されていません。
404	Not found	指定したスキルが存在しないか、スキルにスキルメッセージ資格情報がありません。
429	Too many requests	クライアントが許可された制限回数より多くの呼び出しを行ったときに戻されます。上限は、スキルごとに25 TPSです。
500	Internal server error	有効なリクエストに対して、スキルの資格情報APIが内部サーバーエラーを検出したときに返されます。
503	Service unavailable	サービスを利用できません。