API docs by Redocly

Smartmat API 共通仕様 (0.0.7)

Download OpenAPI specification:Download

E-mail: support@smartmat.jp

Smartmatサービスの安定性向上のため、APIKey毎に「1分60回 & 24時間1440回」の呼び出し回数が制限されています。アプリケーションを作成する際は、実行回数が制限を超えないように調整してください。

在庫情報取得（1件）

在庫情報取得API

デバイスIDをキーに在庫情報を取得します

query Parameters
id
required
string
Example: id=W42190804999

取得したいデバイスID

header Parameters
X-Smartmat-Key
required
string

配布済みのAPI KEY

Responses

Response samples

Content type
application/json
{
  • "device": {
    },
  • "deviceMeasurement": {
    },
  • "measurementControl": [
    ],
  • "subscription": {
    },
  • "subscriptionMeasurement": {
    },
  • "tags": [
    ],
  • "product": {
    }
}

計測履歴情報一括取得（クエリで条件を指定）

計測履歴取得API

デバイスIDをキーに計測履歴情報を取得します（デフォルト直近30件分）

query Parameters
id
required
string
Example: id=W42190804999

取得したいデバイスID

dateFrom
string <date-time>
Example: dateFrom=YYYYMMDDHHMMSS

ログデータを該当日時分以降に絞る。14桁の半角数字のみ設定可。省略可。

dateTo
string <date-time>
Example: dateTo=YYYYMMDDHHMMSS

ログデータを該当日時分以前に絞る。14桁の半角数字のみ設定可。省略可

limit
integer
Example: limit=100

取得件数設定。1〜1000までの半角整数値が設定可。省略可。

header Parameters
X-Smartmat-Key
required
string

配布済みのAPI KEY

Responses

Response samples

Content type
application/json
{
  • "measureHistories": [
    ]
}

発注履歴一括取得（クエリで条件を指定）

発注履歴取得API

発注IDもしくは発注日をキーに発注履歴を取得します（デフォルト最新1000件）

query Parameters
id
integer
Example: id=1234

発注ID(カンマ区切りで複数指定可)

dateFrom
string <date-time>
Example: dateFrom=YYYYMMDDHHMMSS

発注日From

dateTo
string <date-time>
Example: dateTo=YYYYMMDDHHMMSS

発注日To

header Parameters
X-Smartmat-Key
required
string

配布済みのAPI KEY

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

在庫一覧取得（クエリで条件を指定)

在庫一覧取得API

在庫IDをキーに在庫情報を取得します（在庫IDの新しい順で1000件）

query Parameters
subscriptionID
integer
Example: subscriptionID=123456

取得したい在庫ID(カンマ区切りで複数指定可)

pageNumber
integer
Example: pageNumber=3

取得したいページ番号(1ページあたり1,000件固定) 指定がない場合はデフォルト1ページ目が指定される

header Parameters
X-Smartmat-Key
required
string

配布済みのAPI KEY

Responses

Response samples

Content type
application/json
{
  • "counts": 1234,
  • "subscriptions": [
    ]
}