メインコンテンツまでスキップ

認証

認証トークンの生成

SMSの送信リクエストの作成前に、APIキーと秘密鍵を用いて認証トークンを生成する必要があります。APIキーと秘密鍵のどちらも、アカウント設定の手順の一部として、事前にダッシュボード上で設定されています。

エンドポイントURL: https://api.a2p.mobile.rakuten.co.jp/auth/v1/token

メソッド:GET

HTTP ヘッダー

パラメーター要否
Authorization必須Type: Basic
Username: API Key
Password: Secret
Accept必須application/json

https://www.websequencediagrams.com/?png=msc4164179433

レスポンス:

成功した場合は、APIの呼び出しに対するレスポンスが、JSON形式で200 OKとなります。

パラメーター詳細
account_idAPIキーはリクエストの中で送信されました
productSMS
jwt_tokenSMS APIに対する今後の呼び出しのAuthorizationヘッダで、このトークンを伝える必要があります。
token_valid_untilトークンの有効期限は15分で、有効期限はAPIレスポンスの一部として、下記のフォーマットを持つ「token_valid_until」パラメーターでUTCで提供されます: YYYY/MM/DD HH:mm:ss
この有効期限より事前に、新しいトークン生成のリクエストを出すことを確実に行ってください。これにより、今後のAPIの呼び出しにおいて、アカウント情報の失効による認証失敗を回避することができます。

サンプルレスポンス

{
"account": {
"account_id": ".... api key ....",
"product": "SMS"
}
"jwt_token\": \"\.... token \....\",\
"token_valid_until\": \"YYYY/MM/DD HH:mm:ss\",
"additional_claim_values": \[ \]\
}