Company/클래스룸/엔터프라이즈 설정 - 개발자

To create an app that opens in the Onshape UI for internal use or testing:

1. Register the app with Onshape.
2. Create an extension for the app in the Onshape UI.
3. Assign users to the app.

To publish the app to the Onshape App Store for end users:

1. Authenticate with OAuth2.
2. Create an app store entry.
3. Complete the Launch Checklist

1. Click the OAuth applications link on the Developer page to see a list of all your apps:

   

2. Click the Create new OAuth application button.

3. Fill out the form:

   • 이름 - 사용자에게 표시되는 애플리케이션의 이름.

   • Primary format - String that uniquely identifies your application and is a marker for the data it might store on Onshape servers (e.g.,com.example.example). Cannot be changed after the application is registered. Not displayed to users.

   • Summary - Description of the application, shown to the user when they’re asked to grant the application permission to access their data.

   • Redirect URLs - URL to which you are redirected after authentication; the landing page of your application.

     • Your application must specify at least one URL used in the OAuth protocol exchanges.

     • This URL must also use SSL (a URL that begins with https), with two exceptions applicable for installed desktop applications: http://localhost:<port> and urn:ietf:wg:oauth:2.0:oob.

   • Type - Application type: Integrated Cloud App, Connected Cloud App, or Connected Desktop App.

   • OAuth URL - URL used to start the OAuth2 process to authenticate the user. See Developer Docs: OAuth2 for details.

     • Should contain the URL of your deployed application.

     • This is the first URL called from the Onshape Applications page.

     • The page hosted at this URL should handle the OAuth authentication. Once your application’s server has been authenticated on behalf of the user, that user should be redirected to your applications content.

     • If you have not deployed your app yet, you can leave this field blank for local work and update it later.

       All applications submitted to the Onshape App Store for public use must authenticate properly with OAuth2. See Developer Docs: OAuth2 for details.

   • 설정

     • 협업 지원 - 애플리케이션을 개발할 때 다른 사용자와 협업할 것인지 선택합니다.

   • 권한 - 아래 권한 범위를 참조하십시오.

4. 애플리케이션 생성을 클릭합니다.

5. Copy the OAuth secret key from the window.

   You will not be able to access this secret key again. This secret is unique to you and your app. It should be protected like any sensitive password and never checked into source code.

6. The app's OAuth application entry appears with the Details tab active. Selecting the app name on the OAuth applications page now brings you to this screen.

Use the tabs on this screen to:

• Details:

  • Create a store entry for the app

  • Transfer ownership of the app

  • Delete the app

• Settings: Manage app settings

• Keys and secret:
  • Copy the OAuth client identifier key
  • Regenerate a new OAuth client secret key

• Permissions: Modify app permission scopes

• Extensions: Manage app extensions

• Onshape OAuth: Manage Onshape authentication

• External OAuth: Manage third-party authentication

See the Onshape Developer Documentation for more information, including: properly authenticating with OAuth2 and completing Launch Checklist. See the Hello World tutorial for a working example.

1. Click OAuth applications on the Developer page, then select your application.

2. Click the Extensions tab.

   

3. Click Add extension.

4. Fill out the form:

   • Name: Can be truncated in the UI if it is too long.

   • Description (optional): Does not appear in the Onshape UI, but could appear in the authentication grant process.

   • Location: Where the extension exists in the Onshape UI.

     • See Supported Locations and Contexts in the Developer Docs.

     • You can create only one element tab extension per application.

   • Context: Some locations work in the context of a selection, such as inside a Part Studio.

     • See Supported Locations and Contexts in the Developer Docs.

   • Action URL: Locations that embed a UI use the action URL to define the address of the page to display. The action URL is used to specify the REST endpoint if the location is an action (context menu, toolbar item, action in dialog etc.) and the action type is GET or POST. If the location is an action and the action is Open in new window, the action URL is the URL to open in the new window.

     • See Action URL parameters in the Developer Docs for a list of parameters that can be used in this field.

   • Action type: Applicable for locations that do not embed UIs. Supported action types are:

     • GET - This makes a GET API call using the action URL. Parameter replacement is done on the action URL.

     • POST - This makes a POST API call using the action URL and the action body as the post body. Parameter replacement is done on both the action URL and the action body.

     • Open in new window - This opens the action URL in a new browser window. Parameter replacement is done on the action URL.

   • Action body: Only applicable for POST action types. The action body is passed in a POST API call and must be in a valid JSON format.

   • Show response: This is only applicable if the action type is GET or POST. When selected, the UI waits for a response and shows the response in a dialog in the UI. The response must be in a valid JSON format.

   • Icon: The icon is displayed where the extension exist, which can include an icon in an Info panel, context menu action, toolbar button, action button in a dialog, or other supported locations.

5. 확인을 클릭합니다.

For more information on creating and managing Onshape applications, please see the Onshape Developer Docs. Please see the Hello World tutorial for a working example.

Admins can add internal users to applications for testing before submitting to the Onshape App Store. Users added here automatically see the associated app extensions in their Onshape UI, without having to subscribe via the app store.

1. Once your app is registered, click Applications in the left pane.

2. Select the application in the list.

   

3. Begin typing the name or email of a user, team, or alias in the Add users or teams field, and select a result from the list. The admin who created the app is automatically in the Users list. Continue adding names or emails.

   

4. Click the Add button.

Light users cannot be added to applications.

To remove a user, alias, or team from the app, click its X icon in the Remove column.

1. 개발자 설정에서 OAuth 애플리케이션을 클릭합니다.
2. 이전할 앱 이름을 클릭합니다.
3. 세부사항 탭에서 소유권 이전 버튼을 클릭합니다. 이전 대화상자가 열립니다.

   

4. 앱을 개인, Company 또는 엔터프라이즈로 이전하는 옵션을 선택하십시오.
5. 개인에게 소유권을 이전하려면 검색 필드에 새 소유자의 이름 또는 이메일을 입력합니다. Company 또는 엔터프라이즈로 소유권을 이전하려면 드롭다운 메뉴에서 옵션을 선택합니다.
6. 소유권 이전을 클릭합니다. 그러면 애플리케이션이 OAuth 앱 목록에서 제거됩니다.
   • If the app is transferred to an individual account, they receive an email notification and the app appears in their Onshape Developer Portal.
   • If the app is transferred to someone in a Company/Classroom/Enterprise, all Admins receive an email notification and the app appears in their Developer Settings.

향후 API 호출 사용량 및 청구는 새 소유자에게 귀속됩니다. 자세한 내용은 API 제한을 참조하십시오.

Before submitting an app to the Onshape App Store, see the Onshape Developer Documentation for requirements, including properly authenticating with OAuth2 and completing Launch Checklist.

To review, edit, or delete an existing Onshape App Store entry, click Store entries in your Developer settings, then select the entry to modify.

To create a new store entry for an OAuth application:

1. 개발자 설정에서 OAuth 애플리케이션을 클릭합니다.

2. Click the app name in the list.

3. Click Create store entry on the app's Details page.

   

4. Fill out the form:

   

   • Name - Automatically set from the app name provided during registration.

   • Summary - Automatically set from the summary provided during registration.

   • Type - Application type: Integrated Cloud App, Connected Cloud App, or Connected Desktop App. This should match the Type that was selected when registering the OAuth application.

   • Category - Select the appropriate category for your app.

   • Team Visibility - Choose to make the private app store entry visible to no internal users (default), all internal users, or specific teams.

   • Description - User-facing description of the application. Limited formatting allowed.

   • Support URL - URL or email users of your app should be directed to for assistance. This must be actively monitored.

   • Support Email - Email that should receive app subscription notifications. This must be actively monitored.

   • Vendor - Your company name.

   • Version - Current version of this application.

   • Images - Optionally upload summary, hero, and other images.

5. 생성을 클릭합니다.

The application appears in the Onshape App Store as private. It is viewable only to you and any internal teams specified in Team Visibility settings. To make the app public, see the Launch Checklist next.

1. Click Developer in the left pane of your company settings.
2. If your app has an Onshape App Store entry, delete that first:
   1. Click Store entries on the Developer page.
   2. Click the store entry to delete.
   3. Click Delete store entry on the Details tab.
      
   4. Click Delete again to confirm.
   5. Click Developer in the left pane or breadcrumbs to return the Developer landing page.
3. Click OAuth applications in the Developer settings.
4. Click the application to delete.
5. Click Delete application on the Details tab.
   
6. Click Delete again to confirm.

Onshape 앱 스토어(Onshape 앱)에 제출한 모든 애플리케이션은 API 가이드: OAuth2 페이지의 지침을 따르고 인증을 위해 OAuth2를 사용해야 합니다. 자동화 스크립트(또는 Onshape 앱 스토어용이 아닌 애플리케이션)는 인증에 OAuth2 또는 API 키를 사용할 수 있습니다. OAuth2를 사용하면 애플리케이션이 애플리케이션 사용자를 대신하여 Onshape API를 호출할 수 있습니다. API 키는 API 키를 생성한 Onshape 사용자를 대신해서만 작업을 수행합니다.

API 키는 개발자들이 OAuth 워크플로우의 오버헤드를 피할 수 있게 개인적인 용도의 작은 애플리케이션을 생성하는 데 유용합니다.

API 키는 애플리케이션을 인증하는 데 사용되며, 사용자를 인증하는 데는 사용되지 않습니다. (OAuth2는 사용자가 Onshape에 접근할 권한이 있는지 확인하여 애플리케이션 및 애플리케이션 사용자를 함께 인증합니다.) API 키를 생성하면, 해당 키는 생성된 스택에서만 유효합니다. companyName.onshape.com에서 생성된 API 키는 cad.onshape.com에서는 작동하지 않습니다.

Company나 엔터프라이즈와 관련 없는 API 키는 내 계정 - 개발자 페이지에서 관리할 수 있습니다.

API 키 보기

1. Company/클래스룸/엔터프라이즈 개발자 설정에서 API 키를 클릭합니다
2. Company에서 사용할 수 있는 API 키를 검토합니다.
   
   

API 키 생성

1. Company/클래스룸/엔터프라이즈 개발자 설정에서 API 키를 클릭합니다
2. 새 API 키 생성을 클릭합니다.
   
3. 이름 필드에 API 키 이름을 입력합니다.

4. Company 내 사용자에게 API 키를 할당합니다. 사용자 필드에서 이름이나 이메일로 검색할 수 있습니다.

5. 키에 대한 권한을 선택합니다. 아래권한 범위를 참조하십시오.
6. API 키 생성 버튼을 클릭합니다.

7. 팝업 창에서 표시된 API 키와 비밀 키를 복사하여 어딘가에 저장한 다음 닫기 버튼을 클릭합니다.

   You will not be able to access this secret key again. This secret is unique to you and your app. It should be protected like any sensitive password and never checked into source code.

   

8. API 키로 애플리케이션을 인증하는 방법에 대한 자세한 내용은 API 가이드: 인증을 참조하십시오.

API 키 삭제

1. 삭제하려는 API 키 오른쪽에 있는 “X” 아이콘을 클릭합니다.
2. 모든 사용자에 대해 이 API 키를 삭제할지 확인합니다. 이 작업은 취소할 수 없습니다. 삭제를 클릭하여 확인합니다.
   

OAuth 애플리케이션을 만들 때 사용할 수 있는 권한 범위는 다음과 같습니다.

• 애플리케이션에서 프로필 정보를 읽을 수 있음(OAuth2ReadPII) - 애플리케이션이 프로필의 정보에 액세스할 수 있도록 허용하려면 체크합니다.

• 애플리케이션에서 통합문서를 읽을 수 있음(OAuth2Read) - 애플리케이션에 통합문서에 대한 읽기 액세스를 허용하려면 체크합니다.

• 애플리케이션이 통합문서에 쓸 수 있음(OAuth2Write) - 애플리케이션에 통합문서에 대한 쓰기 액세스를 허용하려면 체크합니다.

• 애플리케이션이 통합문서 및 작업 공간을 삭제할 수 있음(OAuth2Delete) -애플리케이션이 통합문서 및 작업 공간을 삭제할 수 있도록 허용하려면 체크합니다.

• 애플리케이션이 사용자를 대신하여 구매를 요청할 수 있음(OAuth2Purchase) - 애플리케이션이 사용자를 대신하여 구매할 수 있도록 허용하려면 체크합니다.

• 애플리케이션이 사용자를 대신하여 통합문서를 공유하고 공유 취소할 수 있음(OAuth2Share) -  애플리케이션이 사용자의 통합문서를 공유하고 공유 취소할 수 있는 권한을 허용하려면 체크합니다.