Company-/Kurs-/Enterprise-Einstellungen – Entwickler

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:

   • Name: Name der Anwendung, die Benutzern angezeigt wird

   • 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.

   • Einstellungen

     • Unterstützt Zusammenarbeit: aktivieren, wenn Sie bei der Entwicklung der Anwendung mit anderen Benutzern zusammenarbeiten möchten

   • Berechtigungen: siehe Berechtigungsbereiche unten

4. Klicken Sie auf Anwendung erstellen.

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. Klicken Sie auf 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. Klicken Sie in Ihren Entwicklereinstellungen auf OAuth-Anwendungen.
2. Klicken Sie auf den Namen der App, die übertragen werden soll.
3. Klicken Sie auf der Registerkarte „Details“ auf die Schaltfläche Eigentümerschaft übertragen. Das Dialogfenster „Übertragen“ wird geöffnet.

   

4. Wählen Sie eine Option aus, um die App an eine Einzelperson, eine Company oder ein Enterprise zu übertragen.
5. Um an eine Einzelperson zu übertragen, geben Sie den Namen oder die E-Mail-Adresse des neuen Eigentümers in das Suchfeld ein. Um die Eigentümerschaft an eine Company oder ein Enterprise zu übertragen, wählen Sie eine Option aus dem Dropdown-Menü aus.
6. Klicken Sie auf Eigentümerschaft übertragen. Die Anwendung wird darauf aus Ihrer OAuth-Apps-Liste entfernt.
   • 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.

Der zukünftige Verbrauch und die Abrechnung von API-Aufrufen werden dem neuen Eigentümer zugerechnet. Weitere Informationen finden Sie unter API-Grenzwerte.

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. Klicken Sie in Ihren Entwicklereinstellungen auf OAuth-Anwendungen.

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. Klicken Sie auf Erstellen.

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.

Für alle im Onshape App Store (Onshape Apps) eingereichten Anwendungen müssen den Anleitungen auf der Seite API Guide: OAuth2 befolgt und OAuth2 zur Autorisierung verwendt werden. Automatisierungsskripte (oder Anwendungen, die nicht für den Onshape App Store gedacht sind), können entweder OAuth2- oder API-Schlüssel für die Authentifizierung verwenden. Bei OAuth2 können Anwendungen Onshape-APIs für die Benutzer aufrufen. API-Schlüssel führen hingegen nur Operationen für den Onshape-Benutzer aus, der die API-Schlüssel generiert hat.

API-Schlüssel sind eine nützliche Methode, um kleine Anwendungen für den persönlichen Gebrauch zu erstellen, sodass Entwickler den Aufwand des OAuth-Workflows vermeiden können.

API-Schlüssel werden verwendet, um eine Anwendung zu authentifizieren, nicht ihre Benutzer. (OAuth2 authentifiziert eine Anwendung und den Benutzer der Anwendung, indem sichergestellt wird, dass die Benutzer für den Zugriff auf Onshape autorisiert sind.) Wenn Sie einen API-Schlüssel erstellt haben, ist er nur für den Stack gültig, auf dem er erstellt wurde. So funktioniert z. B. ein auf companyName.onshape.com erstellter API-Schlüssel nicht auf cad.onshape.com.

API-Schlüssel, die nicht einer Company oder einem Enterprise zugeordnet sind, können über die Seite Mein Konto – Entwickler verwaltet werden.

API-Schlüssel anzeigen

1. Klicken Sie in den Einstellungen für Company/Kurs/Enterprise – Entwickler auf API-Schlüssel.
2. Überprüfen Sie die für die Company verfügbaren API-Schlüssel.
   
   

API-Schlüssel erstellen

1. Klicken Sie in den Einstellungen für Company/Kurs/Enterprise – Entwickler auf API-Schlüssel.
2. Klicken Sie auf Neuen API-Schlüssel erstellen.
   
3. Benennen Sie den API-Schlüssel im Feld Name.

4. Weisen Sie den API-Schlüssel jemandem in der Company zu. Sie können im Feld Benutzer nach dem Namen oder der E-Mail-Adresse suchen.

5. Legen Sie die Berechtigungen für die Schlüssel fest. Siehe Berechtigungsbereiche unten.
6. Klicken Sie auf die Schaltfläche API-Schlüssel erstellen.

7. Kopieren Sie im Popup-Fenster den angezeigten API-Schlüssel und den geheimen Schlüssel, speichern Sie sie und klicken Sie dann auf die Schaltfläche Schließen.

   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. Informationen zur Authentifizierung Ihrer Anwendungen mit API-Schlüsseln finden Sie im API-Leitfaden: Authentifizierung.

API-Schlüssel löschen

1. Klicken Sie auf das „X“-Symbol rechts neben dem API-Schlüssel, den Sie löschen möchten.
2. Bestätigen Sie, dass Sie diesen API-Schlüssel für alle Benutzer löschen möchten. Diese Aktion kann nicht rückgängig gemacht werden. Klicken Sie zur Bestätigung auf Löschen.
   

Die folgenden Berechtigungsbereiche sind beim Erstellen von OAuth-Anwendungen verfügbar:

• Anwendung darf Ihre Profilinformationen lesen (OAuth2ReadPII): Markieren Sie diese Option, um der Anwendung Zugriff auf Informationen in Ihrem Profil zu gewähren.

• Anwendung darf Ihre Dokumente lesen (OAuth2Read): Markieren Sie diese Option, um der Anwendung Lesezugriff auf Ihre Dokumente zu gewähren.

• Anwendung darf Ihre Dokumente ändern (OAuth2Write): Markieren Sie diese Option, um der Anwendung Schreibzugriff auf Ihre Dokumente zu gewähren.

• Anwendung darf Ihre Dokumente und Arbeitsbereiche löschen (OAuth2Delete): Markieren Sie diese Option, wenn die Anwendung Zugriff zum Löschen Ihrer Dokumente und Arbeitsbereiche erhalten soll.

• Anwendung darf in Ihrem Namen Käufe anfordern (OAuth2Purchase): Markieren Sie diese Option, wenn mit der Anwendung etwas gekauft werden darf.

• Anwendung darf Dokumente in Ihrem Namen teilen/nicht mehr teilen (OAuth2Share): Markieren Sie diese Option, wenn mit der Anwendung Dokumente geteilt werden sollen und die Freigabe auch wieder aufgehoben werden kann.