メインコンテンツまでスキップ

クイックスタート

このページでは、ゼロの状態からログインを完了し、最初の API を呼び出すところまでを案内します。

前提条件​

  • デバイスの電源が入っており、ネットワークに接続されていること
  • デバイスの IP アドレスを把握していること（このガイドでは例として 192.168.7.200 を使用します）
  • ログイン用のユーザー名とパスワードを把握していること（デフォルトのユーザー名は admin です）

ステップ 1: デバイスへアクセスできることを確認する​

Web ブラウザで次の URL を開きます：

https://192.168.7.200

デバイスで自己署名証明書付きの HTTPS が有効になっている場合、ブラウザは証明書が信頼されていないと警告します。ローカルでのテストであれば、この警告を無視して先に進んでも構いません。

ステップ 2: ログインして Token を取得する​

ログインエンドポイントには認証は不要です。デバイスにログインリクエストを送信します：

POST https://192.168.7.200/cgi-bin/entry.cgi/system/login
Content-Type: application/json

リクエストボディ：

{
  "sUserName": "admin",
  "sPassword": "your_password"
}
注記

ログインパスワードは平文で送信されます。HTTPS が有効な場合、パスワードは送信中 TLS によって保護されます。

成功すると、レスポンスは次のようになります：

{
  "iStatus": 0,
  "iAuth": 1,
  "sWaittime": 0
}
フィールド説明
iStatus0 = パスワードが正しい、-1 = パスワードが間違っている、-3 = 失敗を繰り返したため一時的にロック中
iAuth1 = ログイン成功、0 = ログイン失敗、2 = パスワード変更が必要
sWaittimeロックされている場合の待機時間（秒）

レスポンスヘッダーには次の情報も含まれます：

Set-Cookie: token=<JWT_TOKEN>; Max-Age=86400; Path=/

この token が、以降すべての API リクエストに対する認証情報となります。

ステップ 3: Token を使って API を呼び出す​

デバイス情報を取得します：

GET https://192.168.7.200/cgi-bin/entry.cgi/system/device-info
Cookie: token=<JWT_TOKEN>

レスポンス：

{
  "sSerialNumber": "RC1126B-20240101-001",
  "sFirmwareVersion": "V1.0.10",
  "sSensorModel": "SC850SL",
  "sBasePlateModel": "Base Board-V1.0,Expand Board-V1.0"
}

リクエストに Token が含まれていない、または Token の有効期限が切れている場合、デバイスは次のように返します：

{
  "code": 401,
  "message": "Unauthorized: Invalid token or NO token provided"
}

Token の有効期間​

Token のデフォルトの有効期間は 24 時間です（Max-Age=86400）。有効期限が切れたら、再度ログインして新しい Token を取得してください。

次のステップ​

  • ログインおよびパスワード変更の詳細なリファレンスについては、Authentication を参照してください
  • レスポンス形式やフィールド命名規則については、Common Conventions を参照してください
  • 機能別に整理されたエンドポイントの説明については、API Reference を参照してください

技術サポートと製品ディスカッション​

弊社製品をお選びいただきありがとうございます。製品をできるだけスムーズにご利用いただけるよう、さまざまなサポートをご用意しています。お好みやニーズに応じて選べる複数のコミュニケーションチャネルを提供しています。

Loading Comments...