Technical Support | Suprema

BioStar 2からBioStar Xへの移行を検討されるお客様が増える中、最も多く寄せられる質問の一つが、このアップグレードが既存のAPIベースの連携機能にどのような影響を及ぼすかという点です。

本記事では、互換性に関する重要な留意点をまとめるとともに、開発者による対応が必要となる既知のAPI変更点について解説します。

全体的なAPI互換性

BioStar 2で使用されているAPIの大部分は、修正なしでそのままBioStar Xでも動作します。

新しいフィールドや構造が追加された場合でも、それらが既存のBioStar 2との連携（インテグレーション）に支障をきたすことはありません。多くの場合、BioStar 2のREST APIに基づいて構築された連携機能は、スムーズにBioStar Xへ移行できます。

重要な例外: /api/setting/biostar のレスポンスボディにおける「licenses」フィールドの構造変更

BioStar 2とBioStar Xの間で互換性が異なるAPIエンドポイントが1つあります。

GET /api/setting/biostar

BioStar Xでは、本APIのレスポンスボディにおける `licenses` フィールドの構造が変更されました。

この変更に伴い、`licenses` フィールドに依存する連携機能については、移行時に見直しと更新を行う必要があります。

BioStar X licenses のフィールド構造

"licenses": {

            "base": {

                "id": ,

                "prodName": ""

            },

            "capacity": {

                "door": 0,

                "user": 0,

                "operator": 0

            },

            "feature": {

                "commServerBase": false,

                "commServerAddonCount": 0,

                "videoCount": 0,

                "serverMatching": false,

                "api": false,

                "visitor": false,

                "tna": {

                    "standard": false,

                    "enterprise": false

                },

                "remoteAccess": false,

                "activeDirectory": false,

                "rollCall": false,

                "gisMap": false,

                "mobile": false,

                "plugin": false,

                "evtLogApi": false,

                "advancedAcs": false

            }

        }

ご利用のアプリケーションが、本エンドポイントから返される `licenses` フィールドの情報を解析または利用している場合は、BioStar X への移行を完了する前に、それに応じたロジックの更新を行ってください。この部分を適切に調整しないと、解析エラーやシステムの誤動作が発生する恐れがあります。

APIドキュメントに関する注記

BioStar X APIの完全なドキュメントはこちらからアクセスできます: BioStar X API Doc

注意事項:

• このドキュメントに記載されていないAPIは、BioStar Xではまだ一般公開されていないことを意味します。

• 今後もエンドポイントや機能が順次リリースされる予定ですので、定期的にドキュメントをご確認いただくことをお勧めします。

• 各バージョンのリリースノートもこのドキュメントに記載されています。

サポートが必要な場合は

BioStar X APIに関するご質問がございましたら、公式サポートチャネルを通じてチケットを送信してください。: Support Page