前提条件: 問い合わせる組織にアクセスできるアカウントが必要です。
APIトークンの作成
Section titled “APIトークンの作成”APIトークンは個人用です。組織の管理画面ではなく自分のアカウントから作成し、作成者と同じアクセス権を持ちます。
- サイドバー下部のアバター → 設定を開き、APIトークンタブを選びます。
- APIトークンを新規作成をクリックします。
- 「CAM Plugin」「ERP Sync」など、連携を識別できる名前を入力します。
- 作成をクリックします。トークンは一度だけ表示されるので、すぐにコピーしてください。再表示はできません。
複数のトークンを作成でき、どのトークンも同じ画面から取り消せます。
リクエストの認証
Section titled “リクエストの認証”各リクエストのAuthorizationヘッダーにトークンを指定します。
Authorization: Bearer <your-token>有効なトークンがない場合は、WWW-Authenticate: Bearerヘッダーを含む401 Unauthorizedが返されます。
{ "errors": ["Access denied"] }組織IDの確認
Section titled “組織IDの確認”ほとんどのエンドポイントはorganization_idのパスパラメータを必要とします。次のリクエストで取得できます。
GET /v1/organizationsAuthorization: Bearer <your-token>レスポンスは組織名とIDの対応表です。
{ "Acme Manufacturing": 12, "Acme Tooling": 15}以降のリクエストでは、この数値IDを使います。
GET /v1/organizations/12/machinesAuthorization: Bearer <your-token>権限によるアクセス範囲
Section titled “権限によるアクセス範囲”正しい組織の有効なトークンがあっても、すべてのレコードが見えるとは限りません。組織内のリソースごとの権限により、範囲がさらに制限されます。
- サイト管理者、または対象リソースの管理者・管理担当者は、組織内の一致するすべてのレコードを見られます。
- 対象リソースのユーザーは、自分が作成したレコード(
user_idがトークンの所有者と一致するもの)だけを見られます。
この制限はリソースごとに適用されます。例えばpartsとmachinesの権限は独立しています。書込みだけでなく、すべての一覧・詳細エンドポイントで確認されます。
エラーレスポンス
Section titled “エラーレスポンス”失敗時には次のステータスが返されます。
| ステータス | 意味 |
|---|---|
401 Unauthorized |
トークンが未指定・無効、または所有者が操作を許可されていない場合。どちらも403ではなく401です。未指定・無効の場合は"Access denied"、権限不足の場合は"You are not authorized to perform this action"となります。存在しないorganization_idは、トークンが届かない組織と同じく権限不足になります。 |
404 Not Found |
レコードが存在しない、または別の組織に属する場合。 |
422 Unprocessable Entity |
検証失敗。本文に項目のエラーを含みます。 |
404の本文にある形式の不一致を含め、詳細はエラーを参照してください。