The SACM API is a RESTful API for exchanging JSON format messages. Using the SACM API enables connectivity with external applications.
Use of the SACM API requires an “API access key” issued from the SACM WebUI. API access key allocation is conducted in BASIC authentication format. Sending a request with authentication information to the specified URL enables access to resources via the SACM.
When you use the SACM API, the rights for the partner account rights used to create the API access key are applied.
Requests are accepted only over HTTPS
Accessing each API requires a Basic Authentication Authorization header created using an API access key
Ex.) if the Access Key is “sacm” and the Access Key Secret is “sacmSecretKey,” then the following header is required.
Authorization: Basic c2FjbTpzYWNtU2VjcmV0S2V5
Attaching the specific parameter “offset-minute” during the API call allows for offset calculation of the date/time parameter included in the input and output values. The unit is specified in “minutes.”
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
If the parameter is omitted, the offset is processed as JST (offset-minute=540).
Status code |
Description |
|---|---|
200 |
Process done normally |
201 |
Process done normally (POST request) |
204 |
Process done normally (Response Body is empty) |
Status code |
Description |
|---|---|
400 |
Request issued with invalid parameters |
401 |
Access made without authentication |
403 |
Resource for which no rights were permitted has been accessed |
404 |
Request issued for nonexistent path |
405 |
Request issued via nonexistent method |
409 |
Control conflict occurred |
415 |
Request issued using unpermitted Content-Type |
500 |
Server error |
503 |
Server maintenance in progress |