僅為這個計畫提供

可讓 Enterprise 管理員建立企業使用者可以訂閱的新應用程式。管理員可以管理與分配這些應用程式給特定的使用者。管理員也可以為其公司或企業的使用者建立、檢視與刪除 API 金鑰。

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

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

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

Enterprise 設定：開發人員

管理員可從這個畫面執行的操作

  • 無需前往 App Store dev portal 即可在公司設定中建立內部的應用程式。

  • 於內部管理應用程式。

  • 為公司中的任何使用者檢視、建立、與刪除 API 金鑰。

  • View API usage for the company, See API Limits for more information on API usage.

  1. 按一下 OAuth 應用程式連結：

    建立新 OAuth 應用程式

  2. 按一下 建立新 OAuth 應用程式 按鈕：

    建立 OAuth 應用程式

  3. 填寫以下資訊 (注意到螢幕中同時提供詳細的資訊)：

    • 名稱 - 向使用者顯示的應用程式名稱。

    • 主要格式 - 辨識您應用程式的獨特字串，不會向使用者顯示。

    • 摘要 - 關於應用程式的資訊。

    • 重新導向 URL - 在認證之後將您重新導向的 URL。

    • 類型 - 應用程式類型。選項有整合的雲端應用程式、連接的雲端應用程式、或連接的桌面應用程式。

    • OAuth URL - 在 Onshape 應用程式頁面中用來開始 OAuth 過程的 URL。

    • 設定

      • 支援協作 - 如果在開發應用程式時要與其他使用者協同合作，請核取此選項。

    • 權限 - 請參考下方的權限範圍。

  4. 按一下 建立應用程式。

  5. 使用「搜尋成員」欄位來找出並選擇要加入至應用程式開發和/或測試的使用者。

  6. 向使用者提供「授權應用程式」螢幕畫面以允許應用程式的存取：

    授權應用程式

  7. 關於使用 OAuth 來授權應用程式的資訊，請參考 API Guide: Authentication。

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

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

API 金鑰是用來驗證應用程式而不是其使用者的 (OAuth2 透過確保使用者有權存取 Onshape 來驗證應用程式與應用程式使用者)。在您建立 API 金鑰之後，其僅在建立它的 stack 中有效。在 companyName.onshape.com 上建立的 API 金鑰將無法在 cad.onshape.com 上作用。

並 未與公司或企業相關的API 金鑰可以透過我的帳戶 - 開發人員的頁面來管理。

檢視 API 金鑰

  1. 在您的公司/課堂/企業開發人員的設定中，按一下 API 金鑰。
  2. 檢閱公司可用的 API 金鑰。
    開發人員螢幕上的 API 金鑰

建立 API 金鑰

  1. 在您的公司/課堂/企業開發人員的設定中，按一下 API 金鑰。
  2. 按一下 建立新 API 金鑰。
    建立新 API 金鑰螢幕畫面
  3. 在名稱欄位中提供 API 金鑰的名稱。

  4. 將 API 金鑰分配給公司中的某人。您可以在使用者欄位中根據名稱或電子郵件搜尋。

  5. 選擇金鑰的權限。請參考下方的權限範圍。
  6. 按一下 建立 API 金鑰按鈕。

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

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

    顯示給使用者的金鑰秘密

  8. 關於使用 API 金鑰來授權應用程式的資訊，請參考 API Guide: Authentication。

刪除 API 金鑰

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

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

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

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

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

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

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

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