公司/課堂/企業設定 - 開發人員

1. 按一下開發人員頁面中的 OAuth 應用程式分頁來查看您所有應用程式的清單：

   

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

3. 填寫表格：

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

   • 主要格式 - 辨識您應用程式的獨特字串，是 Onshape 伺服器上可能儲存資料的標記 (例如，com.example.example)。在註冊應用程式之後無法變更，且不會向使用者顯示。

   • 摘要 - 應用程式的說明，會在要求使用者授予應用程式存取其資料的權限時向使用者顯示。

   • 重新導向 URL - 在認證之後將您重新導向的 URL；您應用程式的登入頁面。

     • 您的應用程式必須至少指定一個用於 OAuth 協定交換的 URL。

     • 這個 URL 必須同時使用 SSL (以 https 開頭的 URL)，但有兩個例外適用於已安裝的桌面應用程式：http://localhost:<port> 和 urn:ietf:wg:oauth:2.0:oob。

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

   • OAuth URL - 用來開始 OAuth2 過程以驗證使用者的 URL。詳情請參考 Developer Docs: OAuth2。

     • 應包含您已部署應用程式的 URL。

     • 這是從 Onshape 應用程式頁面呼叫的第一個 URL。

     • 託管這個 URL 的頁面應處理 OAuth 的驗證。一旦您的應用程式伺服器代表使用著通過了驗證，該使用者應被重新導向至您應用程式的內容。

     • 如果您尚未部屬您的應用程式，可以將此欄位留為空白以進行本機工作，稍後再進行更新。

       所有提交至 Onshape App Store 供公眾使用的應用程式都必須透過 OAuth2 進行適當的驗證。詳情請參考 Developer Docs: OAuth2。

   • Settings

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

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

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

5. 從視窗中複製 OAuth 秘密金鑰。

   您將無法再次存取這個秘密金鑰。這個秘密是專屬於您和您的應用程式的。應該像任何敏感密碼一樣保護它，絕不能被提交到原始程式碼中。

6. 應用程式的 OAuth 應用程式項目出現，且詳細資料分頁是啟用的。在 OAuth 應用程式分頁中選擇應用程式的名稱會將您帶至這個畫面。

使用這個螢幕上的分頁來：

• 詳細資料：

  • 建立應用程式的商店項目

  • 轉移應用程式的所有權

  • 刪除應用程式

• 設定：管理應用程式設定

• 金鑰與秘密：
  • 複製 OAuth 用戶端識別碼
  • 重生成一個新的OAuth 用戶端秘密金鑰

• 權限：修改應用程式的權限範圍

• 擴充功能：管理應用程式的擴充功能

• Onshape OAuth：管理 Onshape 驗證

• 外部 OAuth：管理第三方的驗證

詳細資訊請參考 Onshape Developer Documentation，其中包括使用 OAuth2 來正確驗證，以及完成 Launch Checklist。請參考 Hello World 教學課程來查看可行的範例。

1. 按一下「開發人員」頁面中的 OAuth 應用程式分頁，然後選擇您的應用程式。

2. 按一下擴充功能頁籤。

   

3. 按一下加入擴充功能。

4. 填寫表格：

   • 名稱：如果過長，可以在使用者介面中截短。

   • 說明 (選用)：不會出現在 Onshape 介面中，但可能會出現在驗證授權過程中。

   • 位置：擴充功能在 Onshape 介面中的所在處。

     • 請參考在 Developer Docs 中的 Supported Locations and Contexts。

     • 您僅能為每個應用程式建立一個元素頁籤擴充功能

   • 環境：有些位置是在選擇的環境中作用的，例如 Part Studio。

     • 請參考在 Developer Docs 中的 Supported Locations and Contexts。

   • 動作 URL：嵌入介面的位置會使用動作 URL 來定義要顯示頁面的位址。 如果位置是一個動作 (環境選單、工具列項目、對話方塊中的動作等)，且動作類型是 GET 或 POST，則動作 URL 會被用來指定 REST 端點。如果位置是一個動作且動作是在新視窗中 Open，則動作 URL 會是要在新視窗中開啟的 URL。

     • 請參考在 Developer Docs 中的 Action URL parameters 來了解可用在這個欄位中參數的清單。

   • 動作類型：適用於不嵌入使用者介面的位置。支援的動作類型有：

     • GET - 會使用動作 URL 來做出 GET API 呼叫。會在動作 URL上進行參數置換。

     • POST - 會使用動作 URL 來做出 POST API 呼叫，動作主體會做為 post 主體。會同時在動作 URL 與動作主體上進行參數置換。

     • 在新視窗中開啟 - 這會在新瀏覽器視窗中開啟動作 URL。會在動作 URL上進行參數置換。

   • 動作主體：只適用於 POST 動作類型。動作主體在 POST API 呼叫中傳遞，且必須是使用有效的 JSON 格式。

   • 顯示回應：這僅適用於如果 動作類型是 GET 或 POST。當選取時，使用者介面會等待回應，並在介面的對話方塊中顯示回應。回應必須使用有效的 JSON 格式。

   • 圖示：圖示會顯示在擴充功能所在的位置，可以在資訊窗格、環境選單動作、工具列按鈕、對話方塊中動作按鈕、或其他支援的位置上包含圖示。

5. 按一下確定。

關於建立與管理 Onshape 應用程式的詳細資訊，請參考 Onshape Developer Docs。請參考 Hello World 教學課程來了解可行的範例。

在將應用程式提交到 Onshape App Store 之前，管理員可以將內部使用者加入到應用程式中來進行測試。在此處加入的使用者會自動在其 Onshape 介面中看到相關的應用程式擴充功能，而無需在 App Store 訂閱。

1. 在註冊了您的應用程式之後，按一下左側窗格中的應用程式。

2. 在清單中選擇應用程式。

   

3. 在新增使用者或團隊欄位中輸入使用者、團隊的名稱或電子郵件，然後從清單中選擇一個結果。建立應用程式的管理員 會自動出現在「使用者」清單中。繼續加入名稱或電子郵件。

   

4. 按一下加入按鈕。

無法將輕度使用者加入至應用程式中。

若要從應用程式中移除使用者、別名，或團隊，按一下在移除欄中的 X 圖示。

1. 在您的「開發人員」設定中，按一下 OAuth 應用程式。
2. 按一下要轉移應用程式的名稱。
3. 按一下詳細資料分頁中的轉移所有權按鈕。轉移所有權對話方塊隨即開啟。

   

4. 選擇將應用程式轉移給個人、公司或企業的選項。
5. 若要轉移給個人，請在搜尋欄位中輸入新擁有者的名稱或電子郵件。若要轉移給公司或企業，請從下拉清單中選擇一個選項。
6. 按一下轉移所有權。系統會將應用程式從您的 OAuth 應用程式清單中移除。
   • 如果應用程式是轉移給個人帳戶，他們將會收到電子郵件通知，且應用程式會出現在其 <Onshape Developer Portal 中。
   • 如果應用程式是轉移給公司/課堂/企業中的某人，則所有的管理員會收到電子郵件通知，且應用程式會出現在其「開發人員」設定中。

未來的 API 呼叫消耗和計費將歸屬於新擁有者。詳情請參考 API 限制。

1. 在您公司設定的左側窗格中按一下開發人員，接著按一 OAuth 應用程式，然後選擇要棄用的應用程式。
2. 按一下狀態按鈕來檢視應用程式目前的狀態，以及任何支援狀態的變更。 支援的狀態包括：
   • 啟用 - 在 Onshape App Store 中提供此應用程式。
   • 已棄用 - 該應用程式已從 App Store 中下架，但目前的使用者仍保有存取的權限。
   • 已丟棄 - 已從 OAuth 應用程式分頁將應用程式移除到垃圾桶分頁中。

     • 只有當所有付費訂閱到期後，才允許移除到垃圾通中

     • 會清除所有的購買與授予權限。

   • 已刪除: 永久地從垃圾桶中移除應用程式。無法復原這個操作。
     
3. 選擇所需的狀態變更。
4. 在對話方塊中輸入應用程式的名稱，然後再次點按來確認。

為 OAuth 應用程式建立新的商店項目：

1. 按一下開發人員頁面中的 OAuth 應用程式，然後選擇您的應用程式。

2. 按一下應用程式詳細資料分頁中的建立商店項目按鈕。

   

3. 填寫表格：

   • 名稱 - 自動根據註冊時提供的應用程式名稱設定。

   • 摘要 - 自動根據註冊時提供的摘要設定。

   • 類型 - 應用程式類型：整合的雲端應用程式、連接的雲端應用程式、或連接的桌面應用程式。這應該與註冊 OAuth 應用程式時選擇的類型相符。

   • 類別 - 為您的應用程式選擇合適的類別。

   • 團隊顯示狀態 - 選擇來讓非公開 App Store 項目對內部使用者不可見 (預設)，對所有內部使用者或特定團隊可見。

   • 說明 - 使用者看到的應用程式描述。僅允許有限的格式。

   • 支援 URL - 您應用程式的使用者可用來尋求協助的 URL 或電子郵件。應對此積極地監控。

   • 支援電子郵件 - 用於接收應用程式訂閱通知的電子郵件地址。應對此積極地監控。

   • 廠商 - 您的公司名稱。

   • 版本 - 這個應用程式目前的版本。

   • 影像 - 選擇性地上傳摘要影像、主頁橫幅與其他影像。

4. 按一下建立。

應用程式以私有的出現在 Onshape App Store 中。只有您與在「團隊顯示狀態」設定中指定的內部團隊才能看到。若要將應用程式設定為公開的，請參考 Launch Checklist。

若要回到這個螢幕，按一下商店項目分頁，然後選擇應用程式：

1. 按一下開發人員頁面中的商店項目分頁，然後選擇 您的應用程式。
2. 按一下刪除商店項目。
   
3. 再次按一下刪除來確認。