Edited at

SigfoxクラウドAPI


Sigfox Backend Cloud APIとは

Sigfox Backend Cloud APIは、エンドポイントから、Sigfox Backend Cloudに対し、クラウドのグループ・ユーザー管理、デバイス管理を可能にするAPIです。

本APIを使用するためには、Sigfox Backend Cloudのアクセス権を取得してください。


Sigfox Backend Cloud APIの利用方法

クラウドアクセス権を取得したら、下記の方法でAPIを利用できます。(APIの利用はグループ単位です)

1.GroupタブからAPIを利用するグループを選択

2.左メニューの「API ACCESS」をクリック

3.右上の[New]ボタンをクリック

4.「Api access information」が表示されるので、NameはAPIに付ける名前(適当で結構です)、Profilesには、ログイン中のユーザーに与えられたアクセス権に該当するロールが一覧表示されます。ここでは、"DEVICE MANAGER[W]"を選択し、[OK]ボタンをクリックします。

5.設定した名前のAPIアクセス情報が表示されます。APIはBasic認証でのアクセスとなり、Login、PasswordがBasic認証の時に必要ですので、控えておいてください。また、「API documentation」をクリックすると、利用可能なAPIが表示されます。


デバイスメッセージを取得するAPIを触ってみる

APIのひとつ「Messages sent by a device」を叩いてみましょう。このAPIは下記のURIになっています。ここで、{device-id}のところに、メッセージを取得したいデバイスIDを入力します。

API V2: GET https://api.sigfox.com/v2/devices/{device-id}/messages

ABCDEFというデバイスIDのメッセージを取得する場合を例に、ブラウザでAPIを叩いてみます。

ブラウザで、

https://api.sigfox.com/v2/devices/ABCDEF/messages

にアクセスすると、Basic認証の確認ダイアログが表示されます。ここで、先ほどのLogin、Passwordを入力すると、下記のようなJSONが返ってきます。

{

"data": [
{
"device": {
"id": "ABCDEF"
},
"time": 1556780732000,
"data": "0adb27370147ffe4002203f6",
"rolloverCounter": 0,
"seqNumber": 1814,
"rinfos": [
{
"baseStation": {"id": "587C"},
"delay": 1.8849999904632568,
"lat": "36.0",
"lng": "140.0"
},
{
"baseStation": {"id": "8798"},
"delay": 2.063999891281128,
"lat": "36.0",
"lng": "140.0"
},
{…}
],
"nbFrames": 3,
"operator": "SIGFOX_Japan_KCCS",
"country": "JPN",
"computedLocation": [ ],
"lqi": 3
},
{...}
]}

device(デバイスID)、time(Sigfoxゲートウェイでの受信時刻:unix timestamp)、data(デバイスメッセージ)、seqNumber(シーケンス番号)に続き、rinfosという配列が続きます。このrinfosに、basestation->id(SigfoxゲートウェイのID)、delay(各ゲートウェイからSigfoxクラウドまでの遅延時間)、lat,lngは、Sigfoxゲートウェイの緯度経度(小数点以下省略)を取得できます。

この情報がメッセージ毎に続きます。

※ただし、Sigfoxクラウドへのアクセス権次第では、取得できない項目もあります。


APIで取得可能な情報

APIで取得可能な情報は、先に設定したアクセス権のロールにより異なりますが、DEVICE MANAGER[W]で取得可能な情報は下記のようなものになっています。

項目
内容

Groups
グループ一覧、作成、編集、削除

Users
ユーザ一覧

Device Types
デバイスタイプ一覧、作成、編集、削除、デバイス登録、Callback設定

Devices
デバイス編集、削除、デバイスメッセージ取得

Coverage
Sigfoxサービスエリア情報

※詳しくは、公式のAPI documentationを参照ください。

Sigfox Japan KCCS