Company/Classroom/Enterprise 設定 - 開発者

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. [OK] をクリックします。

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、または Enterprise のオプションを選択します。
5. 個人に引き継ぐには、検索フィールドに新しい所有者の名前またはメールアドレスを入力します。所有権を Company または Enterprise に引き継ぐには、ドロップダウンからオプションを選択します。
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. Click Create.

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 や Enterprise に関連付けられていない API キーは、マイアカウント -開発者 ページで管理できます。

API キーの表示

1. Company/Classroom/Enterprise 開発者設定で、API キーをクリックします。
2. Company で利用できる API キーを確認します。
   
   

API キーの作成

1. Company/Classroom/Enterprise 開発者設定で、API キーをクリックします。
2. [新しい API キーを作成] をクリックします。
   
3. [名前] フィールドに API キーの名前を入力します。

4. Comapny 内の任意のユーザーに 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) - これをオンにすると、アプリケーションにドキュメントの共有と共有解除を許可します。