共通事項

はじめに

SACM API は JSON 形式のメッセージをやり取りする RESTful API です。 SACM API を利用することで、外部のアプリケーションとの連携が可能となります。

利用にあたっては SACM WebUI から発行した「APIアクセスキー」が必要となります。 APIアクセスキーの付与は BASIC 認証形式で行います。 認証情報を付与して特定の URL にリクエストを送ることで SACM 上のリソースにアクセスすることができます。

なお、SACM API 利用時においては APIアクセスキーを発行した 各パートナーアカウントの権限が適用されます。

認証について

  • HTTPS でのリクエストのみが可能です

  • 各 API をアクセスするためには、APIアクセスキーを使った Basic 認証 Authorization ヘッダが必要です

    • (例) Access Key が 「sacm」 、Access Key Secret が 「sacmSecretKey」 だった場合、下記ヘッダが必要になります

      Authorization: Basic c2FjbTpzYWNtU2VjcmV0S2V5
  • SNI (Server Name Indication) に対応した HTTPS クライアントでのみ利用可能です

日時パラメータのオフセット計算

API コール時に特定のパラメータ「offset-minute」を Query String として付加すると、入力値及び出力値に含まれる日時パラメータのオフセット計算を行うことができます。 単位は「分」で指定します。

POST https://*.sacm.jp/public-api/v1/user/tsa99990001/request/md-command?offset-minute=-300
GET https://*.sacm.jp/public-api/v1/user/tsa99990001/event?sacode=tss99990001&type=request&offset-minute=-300

パラメータ省略時は JST (offset-minute=540) として処理されます。

レスポンス時のステータスコード

正常系

ステータスコード 説明
200 正常に処理が完了した
201 正常に処理が完了した(POSTリクエスト)
204 正常に処理が完了した(Response Body は空)

異常系

ステータスコード 説明
400 不正なパラメータでリクエストが行われた
401 認証されていない状態でアクセスが行われた
403 権限として許可されていないリソースにアクセスが行われた
404 存在しないパスに対してリクエストが行われた
405 存在しないメソッドでリクエストが行われた
409 操作に競合が発生した
415 許可されていない Content-Type でリクエストが行われた
500 サーバエラー
503 サーバメンテナンス中