BIM Commons
BIM 属性情報の流通プラットフォーム会員登録ログイン

API(建材・設備機器ライブラリ連携)

建材・設備機器ライブラリ

BLCJ BIM オブジェクト標準に基づく建材・設備機器ライブラリ(カタログ・標準属性)を、全会員に同一条件で提供する API です。利用には会員登録(無料)と API キーが必要です。 認証は API キー(HTTP ヘッダ X-API-Key)。

会員 API キー
取得のながれ
  1. アカウントページから会員登録を申請します(利用規約への同意が必要)。
  2. 運営が承認すると、このページで API キー(arck_live_…)をご自身で発行できるようになります。
  3. 発行したキーを下の欄に保存し、「利用状況」ボタンで疎通を確認します。
キーの保存と確認
※ キーはこのブラウザにのみ保存され(サーバへ送るのは API 呼び出し時のヘッダのみ)、「利用状況」の確認に使われます。
利用方法

すべてのリクエストに HTTP ヘッダ X-API-Key を付けて呼び出します。例:

curl "http://localhost:4183/api/v1/catalog/search?q=換気扇" \
  -H "X-API-Key: arck_live_xxxxxxxx"
料金・無償枠・貢献者優遇は 利用料金 を参照(現在は無償)。
エンドポイント一覧(全 19 件)
詳細仕様書(OpenAPI)を開く
建材・設備機器ライブラリに関係する公益 API のエンドポイントです(仕様書から自動生成・実装と乖離しません)。行をクリックすると該当 API の仕様(パラメータ・レスポンス)へ直接遷移します。 公益 API 全体は「詳細仕様書」をご覧ください。
会員API:ライブラリ(要キー)
MethodPath(クリックで仕様へ)説明
GET
/api/v1/catalog/products
製品詳細をまとめて取得(最大 100 件)
GET
/api/v1/catalog/products/{product_id}
製品詳細(仕様含む)
GET
/api/v1/catalog/resolve
型番から製品を解決
GET
/api/v1/catalog/search
承認済み製品を検索
会員API:BLCJ 標準(要キー)
MethodPath(クリックで仕様へ)説明
GET
/api/v1/blcj/categories
BLCJ カテゴリツリー
GET
/api/v1/blcj/categories/{seven_code}/children
直下の子カテゴリ
GET
/api/v1/blcj/categories/{seven_code}/spec-items
カテゴリの標準属性項目
GET
/api/v1/blcj/search
BLCJ カテゴリを検索
GET
/api/v1/blcj/tables
BLCJ マスタテーブルの一覧
GET
/api/v1/blcj/tables/{table}
BLCJ マスタテーブルのレコード取得
会員API:利用状況(要キー)
MethodPath(クリックで仕様へ)説明
GET
/api/v1/usage
当月の公益 API 利用状況
BLCJ 標準マスタ(公開)
MethodPath(クリックで仕様へ)説明
GET
/api/blcj/categories
BLCJ 分類ツリー(中分類の一覧)
GET
/api/blcj/categories/{seven_code}/children
直下の子分類(小分類・細分)
GET
/api/blcj/categories/{seven_code}/spec-items
分類に適用される標準属性の一覧
GET
/api/blcj/categories/search
BLCJ 分類をキーワードで検索
GET
/api/blcj/categories/smart-search
BLCJ 分類のスマート検索(キーワード+AI 意味検索)
GET
/api/blcj/makers
BLCJ メーカーコード台帳
GET
/api/blcj/version
BLCJ 標準マスタのバージョン
料金(公開)
MethodPath(クリックで仕様へ)説明
GET
/api/public/pricing
料金ポリシーの取得