所有送交至 Onshape App Store (Onshape Apps) 的應用程式必須按照 API Guide: OAuth2 頁面中的說明操作，並使用 OAuth2 來授權。自動化的指令碼 (或不適用於 Onshape App Store 的應用程式) 可以使用 OAuth2 或 API 金鑰來授權。OAuth2 可允許應用程式代表應用程式使用者呼叫 Onshape API；API 金鑰僅會代表產生 API 金鑰的 Onshape 使用者執行操作。

關於操作 Onshape 應用程式的詳細資訊，請參考 Onshape API Developer Documentation。

若要巡覽您 Onshape 中的「開發人員」設定，請按一下 Onshape 視窗右上角的帳戶使用者圖示 (帳戶使用者圖示)。這樣會開啟一個下拉功能表，然後按一下我的帳戶。

按一下頁面左側清單中的開發人員：

我的帳戶：開發人員

On this page you can:

  • Click the API keys link to manage your api keys

  • View your personal API usage. See API Limits for more information on API usage.

API 金鑰是建立供個人使用的小型應用程式的有效方法，允許開發人員避免使用 OAuth 工作流程的負擔。

API 金鑰是用來驗證應用程式而不是其使用者的 (OAuth2 透過確保使用者有權存取 Onshape 來驗證應用程式與 應用程式使用者)。

在您建立了 API 金鑰之後，其僅在所建立的 stack 上有效。在您公司 stack 上建立的 API 金鑰 (i.e., companyName.onshape.com) 將無法在生產的 stack (cad.onshape.com) 上作用。管理員也可以為其公司的使用者管理 API 金鑰：請參考公司/課堂/企業設定 - 開發人員。

檢視 API 金鑰

  1. 按一下「開發人員」頁面中的 API 金鑰。
  2. 檢視您先前建立的 API 金鑰。
    開發人員螢幕上的 API 金鑰

建立 API 金鑰

  1. 按一下 建立新 API 金鑰。
    建立新 API 金鑰螢幕畫面
  2. 在名稱欄位中提供 API 金鑰的名稱。
  3. 選擇金鑰的權限。請參考下方的權限範圍。
  4. 按一下 建立 API 金鑰按鈕。

  5. 在彈出視窗中，複製顯示的 API 金鑰與金鑰秘密，將其儲存於某處，然後按一下 關閉 按鈕。

    您將不會再看到金鑰秘密，因此請將其儲存在安全之處。

    顯示給使用者的金鑰秘密

刪除 API 金鑰

  1. 按一下您要刪除 API 金鑰右側的 "X" 圖示。
  2. 確認您要刪除這個 API 金鑰。無法復原這個操作。按一下 刪除來確認。
    刪除 API 金鑰

在建立 OAuth 應用程式時，會有下列的權限範圍：

  • 應用程式可以讀取您的個人檔案 (OAuth2ReadPII) - 核取以允許應用程式存取您個人檔案中的資訊。

  • 應用程式可以讀取您的文件 (OAuth2Read) - 核取以允許應用程式讀取您的文件。

  • 應用程式可以寫入您的文件 (OAuth2Write) - 核取以允許應用程式寫入您的文件。

  • 應用程式可以刪除您的文件與工作區 (OAuth2Delete) - 核取以允許應用程式刪除您文件與工作區的存取權限。

  • 應用程式可以代表您要求購買 (OAuth2Purchase) - 核取以允許應用程式為您做出訂購。

  • 應用程式可以代表您共享與取消文件共享 (OAuth2Share) -  核取以允許應用程式共享與取消共享您的文件。