API共通仕様

エンドポイント

https://api.unimtx.com

リージョンとエンドポイントでは、利用可能な接続先一覧を確認できます。

共通パラメータ

共通パラメータは、API呼び出し時に必ず指定するURLクエリパラメータです。

Name	Type	Required	Description	Example
action	string	Yes	インターフェース識別子	sms.message.send
accessKeyId	string	Yes	リクエスト用AccessKey ID	MvMa9eLy3BBpZqTj49vuAB

認証

Unimatrixでは、用途に応じて選択できる2種類の認証方式を提供しています。設定はコンソールの Credentials から行い、初期設定はSimple modeです。

Simple Mode [既定]: AccessKey ID のみを検証します。リクエスト署名が不要で、短時間で実装できます。
HMAC Mode: AccessKey Secret を使ってリクエストパラメータを署名し、セキュリティと真正性を高めます。

Simple Mode

Simple modeでは、コンソール Credentials で発行された AccessKey ID を、URLクエリパラメータ accessKeyId に指定するだけで認証できます。

HMAC Mode

HMAC modeでは、すべてのURLクエリパラメータを辞書順に並べた文字列を署名対象とし、指定のハッシュアルゴリズムで署名します。

HMAC modeで追加が必要な共通パラメータは次のとおりです。

Name	Type	Required	Description	Example
algorithm	string	Yes	署名ハッシュアルゴリズム。現在は `hmac-sha256` のみ対応	hmac-sha256
timestamp	number	Yes	タイムスタンプ（ms）。許容誤差は10分	1620243278785
nonce	string	Yes	8〜64文字のランダム文字列	e1098a414d09d2f6
signature	string	Yes	署名文字列	ZlbgmnCqB7Cgb3WI57Q4zrqq50xiQfi/LPbeL2kC

署名生成

リクエストに含まれるすべてのURLクエリパラメータを抽出し、パラメータキーの辞書順（ASC）で並べます。Key=Value を & で結合し、署名対象文字列を生成します。例:
```
accessKeyId=MvMa9eLy3BBpZqTj49vuAB&action=sms.message.send&algorithm=hmac-sha256&nonce=e1098a414d09d2f6&timestamp=1620269782258
```
HmacSHA256 アルゴリズムを使用し、AccessKey ID に対応する AccessKey Secret を署名鍵として署名を生成します。出力はBase64またはHex文字列です。例:
```
ZlbgmnCqB7Cgb3WI57Q4zrqq50xiQfi/LPbeL2kC
```

生成した署名を signature パラメータとして追加して送信します。完全なリクエストURLの例:

https://api.unimtx.com/?action=sms.message.send&accessKeyId=MvMa9eLy3BBpZqTj49vuAB&algorithm=hmac-sha256&timestamp=1620269782258&nonce=e1098a414d09d2f6&signature=xvv9UjzOrQFWe7fFS5IUU9iqIZrncvF093SqXsnfcK8%3D