説明

Milesightゲートウェイ上で呼び出し可能な関連APIがあります。ユーザーは以下の手順に従って、Postmanで関連APIをテストすることができます。

Milesightゲートウェイは、LoRaWAN構成用のHTTP APIを提供します。この記事では、Postmanソフトウェアを使用してこれらのAPIを呼び出す方法を説明します。

必要条件

• Milesightゲートウェイ：UG56、UG65、UG67
• Postmanソフトウェア（または他のAPIツール
• ウェブブラウザ：Chromeを例として

構成

API 認証

ゲートウェイの HTTP API を呼び出すにはトークンが必要です。 このトークンは24時間のみ有効であり、24時間後に再度取得する必要があることに注意してください。 認証タイプはBearer Tokenです。

方法 1: ブラウザ経由でトークンを取得

ステップ 1. ブラウザ経由でゲートウェイのウェブ GUI を開き、右上の3つのドットをクリックし、More tools > Developer toolsをクリックします。

ステップ 2: ゲートウェイにログインするためのユーザー名とパスワードを入力し、ネットワークセクションのログを確認します。

ステップ 3: ログインファイルを見つけ、トークンコンテンツをコピーします。

注：認証タイプはBearer Token（ベアラー・トークン）であり、JWT（JSON Web Token）ではありません。

方法 2: API 経由でトークンを取得

ステップ 1. Postman ソフトウェアを開き、以下の API を入力し、{gatewayIP} を実際のゲートウェイ IP アドレスに置き換えます。

https://{gatewayIP}:8080/api/internal/login

ステップ 2. メソッドを POST に設定し、認証用のボディを入力します。 Send をクリックしてトークンを取得します。

注：認証タイプは JWT ではなく Bearer Token です。

ボディの内容はファームウェアのバージョンによって異なります。

(1) For 60.0.0.42-r5/56.0.0.4 以降の場合：

{
    "username": "admin",
    "password": "sI/7ewBCeWunDs6JXXtSHg=="
}

例：https://anycript.com/crypto

(2) For 60.0.0.42-r4/56.0.0.3-r1 以前の場合：

{
    "username": "apiuser",
    "password": "password"
}

APIテスト

ステップ1. この記事の最後にAPIコマンドのjsonファイルをダウンロードします。

ステップ 2. Postman を開き、[File] > [Import] > [Import File]をクリックして、API コマンドファイルをアップロードしてインポートします。

ステップ 3. インポート後、[Collection] インターフェースで API ファイルが生成されていることが確認できます。

ステップ 4. 右上の目アイコンをクリックして、すべてのパラメータ値を保存する環境を作成します。

[Add] をクリックして新しい環境を作成し、環境に名前を付け、必要に応じて変数を追加します。

この例では、次の 3 つの変数があります。

bearerToken: 前のステップで取得したトークンを貼り付けます

baseUrl: ゲートウェイのIPアドレスです。ポートが8080でない場合は、ポートを追加する必要があります。

organizationID: 1

ステップ5.作成した環境を選択し、左側のリストからAPIを選択し、Sendをクリックして直接応答を取得します。クエリパラメータまたはボディを入力する必要があるコマンドについては、APIドキュメントを参照してください。

例：

1) デバイスのリストを取得

2) デバイスへのダウンリンクコマンドの送信

ダウンリンクを送信する機器の EUI を入力します：

ダウンリンクの内容を以下のように設定します：

• confirmed: false または true。trueを選択した場合、エンド・デバイスはこのダウンリンク・コマンドを受信した後、ACKメッセージ・パケットをサーバに返信します。trueを選択した場合、エンド・デバイスはこのダウンリンク・コマンドを受信した後、ACKメッセージ・パケットをサーバーに返信します
• data:  対応するデバイスを制御するためのダウンリンクコマンド。
• fPort: LoRaWANデバイスがダウンリンクを受信するポート。Milesightエンドデバイスの場合、デフォルトは85ポートです。

ここでは、WS525 のレポート間隔を 1 分に変更するため、以下のように本文を変更します：

{
    "confirmed": true,
    "data": "/wM8AA==",
    "fPort": 85
}

その後、「Send 」をクリックし、ゲートウェイの GUI にアクセスし、「Network Server」>「Packets 」に移動すると、 ゲートウェイがダウンリンクパケットを受信し、センサーから ACK 返信を受信するのが確認できます。

注：ユーザーはセンサーメーカーから関連するダウンリンクコマンドを取得できます。ダウンリンクコマンドをBase64形式のデータコンテンツに変換することを忘れないでください。以下のウェブサイトから、ダウンリンクデータ形式を変換できます。https://conv.darkbyte.ru/