共通仕様
2021.05.28
レート制限
リクエストヘッダー
APIの利用にはアクセストークン(access_token)が必要です。
アクセストークンの取得方法は以下をご確認ください。
フィールド |
タイプ |
説明 |
Content-Type |
String |
Content-Type: application/json |
X-Streaks-Api-Key |
String |
X-Streaks-Api-Key:
|
Authorization |
String |
Authorization: Bearer access_token |
認証
アカウントごとに認証APIリクエストをすることで、一定期間有効なアクセストークンが発行されます。
HTTPリクエスト
POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/auth-token/
URLパラメータ
フィールド |
タイプ |
説明 |
サンプル |
merchant_id |
String |
マーチャントID |
nttsmc |
リクエストボディ
フィールド |
タイプ |
説明 |
mail_address |
String |
メールアドレス |
password |
String |
パスワード |
リクエストボディの例
{
"mail_address": "smartstream@nttsmc.jp",
"password": "nttsmc12345"
}
レスポンス
フィールド |
タイプ |
サンプル |
token |
String |
アクセストークン |
expiration |
DateString |
アクセストークンの有効期間 |
レスポンスの例
{
"token": "20iLCJleHAiOjE0NDc4MzMyMjl9.Ik_yi4lHbNbrRGhqmRpsW82Nls_O9lg12ijij234i2hikjbkjbhbkjnlai4ugq-",
"expiration": "2017-10-01T00:00:00.000Z"
}
エラーコード
ステータスコード |
コード |
メッセージ |
400 |
BAD_REQUEST |
リクエストパラメーターが不正です |
401 |
UNAUTHORIZED |
認証に失敗しました |
500 |
SERVER_ERROR |
予期せぬエラーが発生しました |