共通仕様

レート制限

APIごとに実行できるリクエスト回数はマーチャント単位で異なります。
営業担当までお問合せください。
デフォルト設定は下記の通りです。

プランAPIリクエスト
デフォルト50/分

リクエストヘッダー

特に記載のない限りリクエストヘッダーで下記を指定する必要があります。

フィールドタイプ説明
Content-TypeStringContent-Type: application/json
X-Streaks-Api-KeyStringX-Streaks-Api-Key:

認証

API一部はアクセスするために、アクセストークンを設定する必要があります。
アカウントごとに認証APIリクエストをすることで、一定期間有効なアクセストークンが発行されます。

HTTPリクエスト
POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/auth-token/
URLパラメータ
フィールドタイプ説明サンプル
merchant_idStringマーチャントIDnttsmc
リクエストボディ
フィールドタイプ説明
mail_addressStringメールアドレス
passwordStringパスワード

リクエストボディの例

{
  "mail_address": "smartstream@nttsmc.jp",
  "password": "nttsmc12345"
}
レスポンス
フィールドタイプサンプル
tokenStringアクセストークン
expirationDateStringアクセストークンの有効期間

レスポンスの例

{
  "token": "20iLCJleHAiOjE0NDc4MzMyMjl9.Ik_yi4lHbNbrRGhqmRpsW82Nls_O9lg12ijij234i2hikjbkjbhbkjnlai4ugq-",
  "expiration": "2017-10-01T00:00:00.000Z"
}
エラーコード
ステータスコードコードメッセージ
400BAD_REQUESTリクエストパラメーターが不正です
401UNAUTHORIZED認証に失敗しました
500SERVER_ERROR予期せぬエラーが発生しました