僅為 提供

Allow Enterprise admins to create new applications to which enterprise users can subscribe. Admins can manage and distribute these applications to specified users. Admins can also create, view, and delete API keys for users in their company or enterprise.

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

To navigate to your Developer settings in Onshape, click on your Account user icon (帳戶使用者圖示) in the top right corner of your Onshape window. This opens a dropdown menu. Click Company/Classroom/Enterprise settings.

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

Enterprise 設定：開發人員

What admins can do from this screen

  • Create an internal application in the company settings without going to the App Store dev portal.

  • Manage the application internally.

  • View, create, and delete API keys for anyone in the company.

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

    建立新 OAuth 應用程式

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

    建立 OAuth 應用程式

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

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

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

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

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

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

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

    • 設定

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

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

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

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

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

    授權應用程式

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

All applications submitted to the Onshape App Store (Onshape Apps) must follow the instructions on the API Guide: OAuth2 page and use OAuth2 for authorization. Automation scripts (or applications not meant for the Onshape App Store) may use either OAuth2 or API Keys for authentication. OAuth2 allows applications to call Onshape APIs on behalf of the users of the application; API keys will only perform operations on behalf of the Onshape user who generated the API keys.

API keys are a useful way create small applications meant for personal use, allowing developers to avoid the overhead of the OAuth workflow.

API keys are used to authenticate an application, not its users. (OAuth2 authenticates an application and users of the application by ensuring the users are authorized to access Onshape.) Once you create an API key, it is valid only in the stack on which it was created. An API key created on companyName.onshape.com will not function on cad.onshape.com.

API keys that are not associated with a company or enterprise can be managed through the My Account - Developer page.

檢視 API 金鑰

  1. In your Company/Classroom/Enterprise Developer settings, click API keys
  2. Review the API keys available for the company.
    開發人員螢幕上的 API 金鑰

建立 API 金鑰

  1. In your Company/Classroom/Enterprise Developer settings, click API keys
  2. 按一下 建立新 API 金鑰。
    建立新 API 金鑰螢幕畫面
  3. 在名稱欄位中提供 API 金鑰的名稱。

  4. Assign the API key to someone in the company. You can search by name or email in the User field.

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

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

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

    顯示給使用者的金鑰秘密

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

刪除 API 金鑰

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

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

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

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

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

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

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

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