基本概念

ベースURL

APIはメインアプリのパスではなく、専用のサブドメインで提供されます。

https://api.toolingmetrics.com/v1

リクエストとレスポンスはすべてJSONを使います。書き込みリクエストではContent-Type: application/jsonを設定してください。

組織によるアクセス範囲

Tooling Metricsの各リソースは組織に属します。ほとんどのエンドポイントはorganization_idのパス要素を必要とします。

GET /v1/organizations/:organization_id/machines
GET /v1/organizations/:organization_id/parts

GET /v1/organizationsで組織IDを取得します。存在しないorganization_idには、トークンが届かない組織と同じ本文で401 Unauthorizedを返すため、APIからどの組織IDが存在するかを知ることはできません。レコードはURLで指定した組織の中だけで検索します。別の組織のレコードは、そのレコードの組織のIDではトークンで読み取れる場合でも、存在しないIDと同じ本文で404 Not Foundになります。

所属する有効なorganization_idを指定するだけでは不十分です。リソースごとの権限が表示範囲をさらに制限します。認証の「権限によるアクセス範囲」を参照してください。

認証

すべてのリクエストは、AuthorizationヘッダーにBearerトークンを必要とします。

Authorization: Bearer <your-token>

トークンは個人用です。組織の管理画面ではなく、アカウント設定（アバター → 設定）のAPIトークンタブで作成・取消しを行います。作成者と同じアクセス権を持ちます。認証を参照してください。

ページ分割なし

一覧エンドポイント（index、search）はページ分割しません。一致するすべてのレコードを1つのレスポンスで返し、pageやper_pageはありません。件数が多い組織では、本文が大きくなることを考慮してください。ページ分割ではなく、各リファレンスで説明する検索パラメータで絞り込みます。

一覧レスポンスは、ラッパーのないJSON配列です。

[
  { "id": 1, "...": "..." },
  { "id": 2, "...": "..." }
]

例外はOrganizations#showで、配列ではなく組織名とIDを対応付けるJSONオブジェクトを返します。

一覧と詳細

リソースによっては、次の2つの表現があります。

• 一覧（GET /resources）— プロジェクトは簡潔な概要。機械、加工部品、工具アセンブリは詳細と同じネスト構造。
• 詳細（GET /resources/:id）— 関連データを含む完全なオブジェクト。

例えばGET /projectsは{id, name, status, locked}の概要を返し、GET /projects/8はジョブと工程を含む完全なプロジェクトを返します。機械と加工部品は、indexとshowで同じ完全な形式を返します。

読取り専用リソース

工具アセンブリの作成・編集はTooling Metricsの画面で行います。APIでは読取り専用で、POST、PATCH、DELETEのルートはありません。このパスへ書込みメソッドを送ると、ルートに一致せず、定型のJSONエラーではなくルーティング層の失敗になります。文書化したステータスが返るとは限りません。GETのみを使用してください。

日時形式

タイムスタンプはすべて、UTCのISO 8601文字列で返します。

"created_at": "2026-06-02T08:30:00Z"

書込みリクエストでも同じ形式を使います。

添付ファイル

画像、図面、STEPモデルは、multipartではなくJSON本文内のBase64エンコード文字列で送信します。

{
  "number": "P-0042",
  "model": "<base64-encoded-step-content>"
}

項目名と例は加工部品のリファレンスを参照してください。

レート制限

1トークンにつき毎分60リクエストです。X-RateLimit-*ヘッダーはありません。制限関連のヘッダーは、429時のRetry-Afterだけです。レート制限を参照してください。

よくある連携

連携	内容	開始ページ
CAMソフトウェア	工具アセンブリと切削データを読み取り、プログラミング後にプロジェクトを送信	CAM連携ガイド（未公開）。利用できるエンドポイントはリファレンスを参照。
ERP / MRP	在庫品目と購入注文を同期する構想。これらのエンドポイントは未実装	ERP同期ガイド（未公開）。現時点のAPI対応範囲は未対応の機能を参照。
工具プリセッタ	測定したオフセットを書き戻す構想。セット工具への書き込みエンドポイントは未実装	生産の自動化ガイド（未公開）。現時点のAPI対応範囲は未対応の機能を参照。
独自の自動処理	出庫リストの作成や工具収納部の監視の構想。出庫リストの作成エンドポイントは未実装	生産の自動化ガイド（未公開）。現時点のAPI対応範囲は未対応の機能を参照。

未対応の機能

APIは組織、機械、工具アセンブリ、加工部品、プロジェクトに対応しています。在庫品目、実物の工具の状態・場所、出庫リスト、購入注文はまだ公開しておらず、画面のみで利用できます。在庫水準や購買データを取得するAPIは現時点ではありません。連携ガイドは未公開です。利用できる範囲はリファレンスを参照してください。

関連記事

• 入門
• 認証
• エラー
• レート制限
• 変更履歴