コンテンツにスキップ
言語の選択:日本語
テーマの選択

入門

5分以内にトークンを作成し、最初のAPIリクエストを送信します。

更新日:

必要なもの: 少なくとも1つの組織にアクセスできるTooling Metricsアカウント。

Tooling Metrics APIはHTTPS上のJSON REST APIです。すべてのリクエストにBearerトークンが必要です。

  1. Tooling Metricsで、サイドバー下部のアバター → 設定 → APIトークンタブを開きます。
  2. APIトークンを新規作成をクリックします。
  3. このトークンの名前を入力します(例:erp-integration、cam-plugin)。
  4. 作成をクリックします。トークンは一度だけ表示されます。すぐにコピーしてください。再表示はできません。

ほとんどのAPIエンドポイントはorganization_idのパスパラメータを必要とします。次の方法で取得します。

curl https://api.toolingmetrics.com/v1/organizations \
-H "Authorization: Bearer YOUR_TOKEN"

レスポンスは組織名と数値IDの対応表です。

{
"Acme Manufacturing": 12,
"Acme Tooling": 15
}

以降のリクエストでは、この数値IDを使います。

ステップ3:最初のリクエストの送信

Section titled “ステップ3:最初のリクエストの送信”

組織の機械一覧を取得します。

curl https://api.toolingmetrics.com/v1/organizations/12/machines \
-H "Authorization: Bearer YOUR_TOKEN"

JSON配列を伴う200 OKが返れば、認証とアクセス範囲の確認は正常です。

APIエラーはJSONを返し、ほとんどはerrors配列を使います。

{ "errors": ["Description of what went wrong"] }
ステータス 原因 対応
401 トークンが未指定・無効、または有効でもリソースの権限がない(存在しないorganization_idを含む) メッセージを確認します。トークンがない場合は認証を求めるメッセージ、権限不足の場合は「You are not authorized to perform this action」と表示されます。
404 レコードが存在しない、または別の組織に属する IDと、レコードがURLのorganization_idの組織に属することを確認します。存在しないorganization_idは401になります。本文のキーはerrorsではなく単数形のerrorです。
422 検証失敗 レスポンスのerrors配列を確認します。
429 レート制限超過 Retry-After秒待って再試行します。

このAPIには403がありません。トークン未指定・無効と、有効でも権限不足の場合は、どちらも401となり、メッセージだけで区別します。errorとerrorsの不一致を含む詳細はエラーを参照してください。

詳細なリファレンスはエラーを参照してください。

  • 基本概念 — 組織によるアクセス範囲、ページ分割、日時形式、読取り専用リソース。
  • ガイド(未公開)— CAM連携、ERP同期、生産の自動化の手順。現在の対応範囲は基本概念を参照してください。
  • リファレンス — エンドポイントの詳細。