スマートマットのAPI連携について

目次

• APIから取得できるデータ
• APIキーの取得手順
• APIの呼び出し例

スマートマットのAPI連携についてご案内します。
APIを利用して計測データ等を他システムへ連携ができ、高度な在庫管理業務にお役立ていただけます。

(2023/09/06追記) 2023年10月のリリースより、在庫一覧取得APIのレスポンスにマット情報が追加されます。詳細はこちら

(2024/06/26追記) 2024年6月末のリリースより、リクエスト回数制限の緩和を行いました。

APIから取得できるデータ

Smartmat API 共通仕様

取得できるAPI

• 在庫一覧取得 API
  → 在庫の棚卸データ取得にはこちらを推奨しています
• 発注履歴一括取得 API
  → 発注の定期的な自動連携にご利用いただけます
• 在庫情報取得 API
  → 在庫一覧取得 API の提供にともない非推奨となりました
• 計測履歴一括取得 API

各APIで取得できる詳細項目はsmartmat API 共通仕様をご確認ください。
Responses 欄にある緑背景の 200 レスポンス（成功）をクリックすると、各項目が確認できます。

2023/10/10のリリースより、在庫一覧取得APIのレスポンスに以下のマット情報が追加されます。
詳細は最新のAPI共通仕様書を参照してください。

• devices: 下記マット情報の配列（マルチマットの場合複数の情報が返却されます）
  • device
    • deviceSerialNumber: デバイスID（string）
    • version: デバイスバージョン（string）
  • deviceMeasurement
    • isConnected: 最新計測状態（boolean）
    • current: デバイスとしての最新計測値（グラム単位）（integer）
    • measuredAt: 最終計測日時（datetime）
    • battery: 最新バッテリー残量（integer）
    • rssi: 最新電波強度（integer）
  • measurementControl
    • frequency: 計測頻度（integer）
    • timing: 計測時刻（string）
    • standardHour: 基準時刻（integer）

APIキーの取得手順

1. ページ右上の [ 企業名 ] ＞ [ 管理者設定 ] をクリック

2. [ API ] ＞ [ APIkey 表示 ] or [ APIKey 取得 ] をクリック

2-1. APIKeyの取得が初めての場合

まだAPIKeyを取得したことがない場合は「APIKey未設定」と表示されます。[ APIKey 取得 ] をクリックして取得してください。

2-2. APIKeyを既に取得している場合

これまでにAPIKeyを取得したことがある場合は伏字が表示されます。[ APIkey 表示 ]をクリックして確認してください。

データ取得の際にエラーが出る場合の対処

• 429エラー（Too Many Requests）
  •  連続してリクエストする場合は、下記の条件に従ってリクエストを行ってください。どちらかでも制限を超えた場合エラーが発生します。
    • 1分 : 60回まで
    • 1日 : 1440回まで
  • リクエスト回数の判定は初回の実行時刻を基準に行います。
    • 1分の場合、直近1分でリクエストがなければ次回実行時が基準時刻になります。
    • 1日の場合、直近24時間でリクエストがなければ次回実行時が基準時刻になります。
  • リクエスト回数はAPIKey毎にカウントされるため、実行するエンドポイントを変更しても同様にカウントされます。
• 503エラー（Service Unavailable）
  •  リクエストを行っているPCのネットワークセキュリティを確認してください。
    • セキュリティでアクセスが制限されているとエラーが発生します。

APIの呼び出し例

下記をご確認ください。

• API呼び出し例資料
• スマートマットのAPI呼び出し例