最初の質問:どの種類のデバイスを接続するのか?
通信方式や導入トポロジーを選ぶ前に、より根本的な問いに答える必要があります。お使いのデバイスは Cams Biometrics のデバイスですか、それとも Cams 開発者ポータルで検証済みのデバイスですか?
この質問への回答によって、プッシュモードが完全に決まります。「はい」の場合は Native Push を使用し、それ以上の判断は不要です。「いいえ」の場合は Hybrid Push の範囲となり、一連の追加の判断が必要になります。
Mode 1
Native Push
すべての Cams Biometrics 製機器、および developer.camsbiometrics.com で検証済みとして掲載されているすべてのデバイスが対象です。デバイスはインターネット経由で Biometric Gateway と直接通信し、追加の設定は不要です。
38のオペレーションすべて
Callback API フル対応
RESTful API フル対応
Mode 2
Hybrid Push
その他すべての検証されていないデバイスが対象です。環境に適した通信方式と導入トポロジーを選択します。API の利用可否は、選択した組み合わせによって異なります。
通信方式3種類
トポロジーオプション2種類
API アクセスは構成により異なる
Native Push:全体像
Native Push デバイスは、デバイスをインターネットに接続する以外の設定なしで、Gateway の38のオペレーションすべてにフルアクセスできます。Callback API はイベントを遅延なしで配信します。RESTful API のコマンドは約15秒で実行されます。SDK、ローカルソフトウェア、トポロジーの判断は一切不要です。
Hybrid Push の理解:3つの通信方式
お使いのデバイスが Cams または検証済みデバイスでない場合、次の判断は、Gateway が実際にお使いのハードウェアとどのように通信するかです。利用可能な通信方式は3種類あり、それぞれ要件が異なり、使用できる API 機能も異なります。
通信方式はネットワーク構成の問題ではありません。Gateway が特定のデバイスからデータを読み取り、特定のデバイスにコマンドを送信するための技術的な仕組みに関するものです。この選択は、ハードウェアがサポートする内容によって制約されます。
a
Device SDK
フル API アクセスに最適なオプション
Gateway は、デバイスメーカーの SDK を使用してハードウェアと通信します。SDK が低レベルのデバイスプロトコルを処理し、Gateway は SDK がサポートするすべての機能を API を通じて公開します。これは Hybrid Push において RESTful API の操作を有効にできる唯一の通信方式です。
Callback API フル対応 + RESTful API フル対応(SDK の機能範囲内)
b
DB Pull
勤怠データのみ
Gateway は、デバイス付属の管理ソフトウェアが勤怠記録を書き込むローカルデータベースから読み取ります。Gateway はこのデータベースを監視し、新しい記録をリアルタイムでお使いのコールバック URL に送信します。デバイスとの直接通信は行われないため、デバイスにコマンドを送信することはできません。ユーザーの追加、記録の削除、ログの読み込みなどの操作は利用できません。
Callback API:勤怠およびパンチログのみ。RESTful API:非対応。
c
File Processing
勤怠データのみ
ローカルコンピュータ上の指定された勤怠ファイルが継続的に監視されます。デバイスソフトウェアがこのファイルに新しい勤怠記録を更新するたびに、Gateway は変更を検出し、新しい記録を抽出して、リアルタイムでお使いのコールバック URL に送信します。DB Pull と同様に、この方式はデバイスの観点からは読み取り専用であり、同じ API の制限があります。
Callback API:勤怠およびパンチログのみ。RESTful API:非対応。
通信方式の選び方
お使いのデバイスに Cams Gateway がサポートするメーカー SDK がある場合は、Device SDK (a) を選択してください。これは Hybrid Push デバイスで RESTful API の操作を利用可能にする唯一の方式です。SDK がサポートされていない、または利用できない場合でも、DB Pull (b) または File Processing (c) により、勤怠データをリアルタイムでコールバックエンドポイントに配信できます。多くのユースケースではこれで十分です。
Hybrid Push の理解:2つの導入トポロジー
通信方式を選択したら、2つ目の判断は、Gateway がデバイス、データベース、またはファイルにどこから接続するかです。これがトポロジーの判断であり、デバイスの物理的な設置場所におけるネットワーク環境によって決まります。
トポロジー X
直接接続
デバイスが接続されている現場のコンピュータ、またはデバイス管理ソフトウェアが動作しているコンピュータが、パブリック IP アドレスを持ち、ローカルネットワークへのポート転送が設定されています。Biometric Gateway はインターネット経由で、デバイス、データベース、またはファイルに直接接続します。
必要条件:パブリック IP + 現場でのポート転送
トポロジー Y
間接接続
現場のコンピュータに Hybrid Connector アプリケーションがインストールされます。これはローカルマシンと Biometric Gateway の間の送信型ブリッジとして機能し、外部からの受信接続を必要とせず、内部から接続を確立します。お客様側にパブリック IP は不要です。
必要条件:ローカルコンピュータへの Hybrid Connector のインストール。パブリック IP は不要。
トポロジーの推奨事項
現場でパブリック IP やポート転送を設定できない場合は、Hybrid Connector を使用した間接接続(Y)を選択してください。これは最もシンプルな導入方法であり、お客様側でネットワーク設定を行う必要が完全になくなります。パブリック IP が利用可能で設定済みの場合は、直接接続(X)も使用でき、現場で追加のソフトウェアをインストールする必要はありません。
判断ツリー:どのモードを選ぶべきか?
この判断ツリーを上から下へたどってください。自分の状況に当てはまる最初の回答で止めてください。
判断ツリー、上から開始
1. お使いのデバイスは Cams Biometrics のデバイスですか、または developer.camsbiometrics.com で検証済みとして掲載されていますか?
はい Native Push を使用します。API にフルアクセスできます。それ以上の判断は不要です。
いいえ 質問 2 に進んでください。
2. Cams Gateway は、お使いのデバイスメーカーの SDK をサポートしていますか?
はい Hybrid Push, Device SDK (a) を使用します。Callback および RESTful API に SDK の制限内でフルアクセスできます。トポロジーについては質問 3 に進んでください。
いいえ 質問 2b に進んでください。
2b. デバイス管理ソフトウェアは、勤怠記録をローカルデータベースに書き込みますか?
はい Hybrid Push, DB Pull (b) を使用します。勤怠の Callback のみ。トポロジーについては質問 3 に進んでください。
3. 現場のコンピュータにパブリック IP アドレスがあり、ポート転送が利用可能ですか?
はい 直接トポロジー (X) を使用します。現場で追加のソフトウェアは不要です。
いいえ 間接トポロジー (Y) を使用します。現場のローカルコンピュータに Hybrid Connector をインストールしてください。
Hybrid Push 機能対応マトリクス
以下の表は、通信方式と導入トポロジーのすべての組み合わせと、各ケースで利用可能な API 機能を示しています。判断ツリーと併せて使用し、選択した構成がサポートする内容を確認してください。
| モード |
通信方式 |
トポロジー |
Callback API |
RESTful API |
| 直接デバイス |
(a) Device SDK |
(X) パブリック IP |
フル |
フル(SDK の制限あり) |
| 間接デバイス |
(a) Device SDK |
(Y) Hybrid Connector |
フル |
フル(SDK の制限あり) |
| 直接 DB |
(b) DB Pull |
(X) パブリック IP |
勤怠のみ |
非対応 |
| 間接 DB |
(b) DB Pull |
(Y) Hybrid Connector |
勤怠のみ |
非対応 |
| 直接ファイル |
(c) File Processing |
(X) パブリック IP |
勤怠のみ |
非対応 |
| 間接ファイル |
(c) File Processing |
(Y) Hybrid Connector |
勤怠のみ |
非対応 |
重要なハードウェアの注意事項
ハードウェアの制限により、Device SDK モードであっても API 機能がさらに制限される場合があります。デバイスモデルのファームウェアバージョンや、メーカーの SDK が公開する機能によっては、特定の API が動作しないことがあります。上記のマトリクスは Gateway のアーキテクチャがサポートする内容を示すものであり、個々のデバイスモデルがすべての機能をサポートすることを保証するものではありません。本番環境に導入する前に、必ずお使いの特定のハードウェアでテストし、エッジケースについては Cams サポートチームに確認してください。
トポロジーの判断が影響する範囲と影響しない範囲
よくある混乱の原因は、トポロジーと API の利用可否の関係です。直接接続か間接接続かというトポロジーの選択は、利用可能な API 機能には影響しません。API 機能セットは、通信方式によってのみ決まります。
トポロジーが影響するのは、Gateway とお客様のローカル環境の間のネットワーク接続の確立方法です。直接接続にはパブリック IP と現場でのポート転送が必要です。間接接続にはローカルマシンへの Hybrid Connector のインストールが必要です。利用可能な API 機能は、Direct Device SDK と Indirect Device SDK で同一であり、Direct DB Pull と Indirect DB Pull でも同一です。
“統合に必要な API 機能に基づいて通信方式を選択してください。ネットワーク環境がサポートする内容に基づいてトポロジーを選択してください。これらは独立した判断です。”
よくある質問
DB Pull または File Processing を RESTful API コマンドと併用できますか?
いいえ。DB Pull と File Processing は読み取り専用の統合方式です。Gateway がデバイス付属のソフトウェアによって生成された勤怠データを観察することはできますが、デバイスにコマンドを送り返すための経路を確立するものではありません。ユーザーの追加、記録の削除、ログの読み込みなどの RESTful API の操作には、双方向の通信経路を作成する Device SDK モードが必要です。
Hybrid Connector は、デバイスソフトウェアと同じコンピュータにインストールする必要がありますか?
はい。Hybrid Connector は、デバイスが接続されている、またはデバイス管理ソフトウェアが動作している、同じローカルコンピュータにインストールする必要があります。通信方式に応じて、デバイス、ローカルデータベース、または勤怠ファイルへのローカルアクセスが必要になるためです。Connector はその後、Gateway への送信トンネルを作成するため、その場所にパブリック IP は不要になります。
Native Push と Hybrid Push の遅延の違いは何ですか?
Native Push の場合、Callback API のイベントは遅延なしで配信され、RESTful API のコマンドは約30秒で実行されます。Device SDK を使用した Hybrid Push の場合、遅延は SDK 独自の通信サイクルに依存し、デバイスメーカーによって異なります。DB Pull と File Processing の遅延は、ローカルソフトウェアが新しい記録を書き込む頻度と、Gateway が変更を検出する速度に依存します。通常、デバイスがイベントを記録してから数秒以内です。
結論:モードを制約条件に合わせる
Cams Biometric Gateway の接続モードの判断は、好みの問題ではなく、制約条件の問題です。デバイスが条件を満たす場合は、最小限の設定で最大の機能を提供する Native Push が適切な選択です。それ以外のすべての場合は Hybrid Push となり、その中では Device SDK モードが、API アクセスの点で Native Push に最も近いものを提供します。
SDK への完全なアクセスが利用できない場合、DB Pull と File Processing は、システムにリアルタイムの勤怠データを届ける現実的な方法です。トポロジーの判断は、API が何をできるかを変えない、インフラストラクチャレベルの別の選択となります。
判断ツリーから始め、機能マトリクスで選択内容を確認し、ハードウェアでテストし、本番環境に移行する前にエッジケースについて Cams サポートチームに確認してください。