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"
料金・無償枠・貢献者優遇は 利用料金 を参照(現在は無償)。
エンドポイント一覧
詳細仕様書(OpenAPI)を開く
建材・設備機器ライブラリに関係する公益 API のエンドポイントです(仕様書から自動生成・実装と乖離しません)。行をクリックすると該当 API の仕様(パラメータ・レスポンス)へ直接遷移します。 公益 API 全体は「詳細仕様書」をご覧ください。