SmartSTREAM Support Manual
Return to Support Manual TOPCommon Specifications
Table of Contents
Rate Limits
| Plan | API Requests |
|---|---|
| Default | 50/min |
Request Headers
An access token (access__token) is required to use the API.
Please refer below for instructions on how to obtain an access token.
| Field | Type | Description |
|---|---|---|
| Content-Type | String | Content-Type: application/json |
| X-Streaks-Api-Key | String | X-Streaks-Api-Key: |
| Authorization | String | Authorization: Bearer access_token |
Authentication
By sending an authentication API request for each account, an access token valid for a certain period will be issued.
HTTP Request
POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/auth-token/
URL Parameters
| Field | Type | Description | Example |
|---|---|---|---|
| merchant_id | String | Merchant ID | nttsmc |
Request Body
| Field | Type | Description |
|---|---|---|
| mail_address | String | Email address |
| password | String | Password |
Request Body Example
{
"mail_address": "smartstream@nttsmc.jp",
"password": "nttsmc12345"
}
Response
| Field | Type | Example |
|---|---|---|
| token | String | Access token |
| expiration | DateString | Access token expiration period |
Response Example
{
"token": "20iLCJleHAiOjE0NDc4MzMyMjl9.Ik_yi4lHbNbrRGhqmRpsW82Nls_O9lg12ijij234i2hikjbkjbhbkjnlai4ugq-",
"expiration": "2017-10-01T00:00:00.000Z"
}
Error Codes
| Status Code | Code | Message |
|---|---|---|
| 400 | BAD_REQUEST | Invalid request parameters |
| 401 | UNAUTHORIZED | Authentication failed |
| 500 | SERVER_ERROR | An unexpected error has occurred |