Paramètres Company/Classe/Enterprise - Développeur

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:

   • Nom - Nom de l'application affichée aux utilisateurs.

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

   • Réglages

     • Favorise la collaboration - Cochez si vous souhaitez collaborer avec d'autres utilisateurs lors du développement de l'application.

   • Autorisations - Voir Étendue des autorisations ci-dessous.

4. Cliquez sur Créer une application.

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. Cliquez sur 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. Dans vos paramètres de développeur, cliquez sur Applications OAuth.
2. Cliquez sur le nom de l'application à transférer.
3. Cliquez sur le bouton Transférer la propriété dans l'onglet Détails. La boîte de dialogue Transférer s'ouvre.

   

4. Sélectionnez une option pour transférer l'application à une personne, une société ou une entreprise.
5. Pour transférer la propriété à une personne, saisissez le nom ou l'adresse e-mail du nouveau propriétaire dans le champ de recherche. Pour transférer la propriété à une société ou à une entreprise, sélectionnez une option dans la liste déroulante.
6. Cliquez sur Transfert de propriété. L'application est supprimée de votre liste d'applications 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.

La consommation et la facturation des futurs appels à une API seront attribuées au nouveau propriétaire. Consultez la section Limites d'API pour plus de détails.

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. Dans vos paramètres de développeur, cliquez sur Applications 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. Cliquez sur Créer.

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.

Toutes les applications soumises sur l'App Store Onshape (Onshape Apps) doivent suivre les instructions de la page Guide des API : OAuth2 et utiliser OAuth2 pour l'autorisation. Les scripts d'automatisation (ou les applications qui ne sont pas destinées à l'App Store Onshape) peuvent utiliser OAuth2 ou des clés API pour s'authentifier. OAuth2 permet aux applications d'appeler les API Onshape pour le compte des utilisateurs de l'application ; les clés API n'effectueront les opérations que pour le compte de l'utilisateur Onshape qui les a générées.

Les clés API sont un moyen utile de créer de petites applications destinées à un usage personnel, ce qui permet aux développeurs de s’épargner la charge des flux de travail OAuth.

Les clés API sont utilisées pour authentifier une application, et non ses utilisateurs. (OAuth2 authentifie une application et ses utilisateurs en s'assurant qu'ils sont autorisés à accéder à Onshape.) Une fois que vous avez créé une clé API, elle n'est valide que dans la pile sur laquelle elle a été créée. Une clé API créée sur MonEntreprise.onshape.com ne fonctionnera pas sur cad.onshape.com.

Les clés API qui ne sont pas associées à une société ou à une entreprise peuvent être gérées via la page Mon compte - Développeur.

Affichage des clés d'API

1. Dans les paramètres Développeur de votre plan Company/Classe/Enterprise, cliquez sur Clés API
2. Consultez les clés API disponibles pour la société.
   
   

Création de clés d'API

1. Dans les paramètres Développeur de votre plan Company/Classe/Enterprise, cliquez sur Clés API
2. Cliquez sur Créer une nouvelle clé d'API.
   
3. Entrez le nom de la clé API dans le champ Nom.

4. Assignez la clé API à un membre de la société. Vous pouvez effectuer une recherche par nom ou par adresse e-mail dans le champ Utilisateur.

5. Choisissez les autorisations pour les clés. Consultez la section Étendue des autorisations ci-dessous.
6. Cliquez sur le bouton Créer une clé d'API.

7. Dans la fenêtre contextuelle, copiez la clé API et la clé secrète affichées, enregistrez-les quelque part, puis cliquez sur le bouton Fermer.

   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. Pour plus d'informations sur l'authentification de vos applications à l'aide de clés d'API, consultez le Guide des API : Authentification.

Suppression des clés d'API

1. Cliquez sur l'icône « X » à droite de la clé d'API que vous souhaitez supprimer.
2. Confirmez que vous souhaitez supprimer cette clé d'API pour tous les utilisateurs. Cette action ne peut pas être annulée. Cliquez sur Supprimer pour confirmer.
   

Les étendues d'autorisation suivantes sont disponibles lors de la création d'applications OAuth :

• L'application peut lire les informations de votre profil (OAuth2ReadPii) - Cochez cette case pour autoriser l'application à accéder aux informations de votre profil.

• L'application peut lire vos documents (OAuth2read) - Cochez cette case pour autoriser l'application à accéder à vos documents en lecture.

• L'application peut écrire dans vos documents (OAuth2Write) - Cochez cette case pour autoriser l'application à accéder à vos documents en écriture.

• L'application peut supprimer vos documents et espaces de travail (OAuth2Delete) - Cochez cette case pour autoriser l'application à accéder à vos documents et espaces de travail.

• L'application peut demander des achats en votre nom (OAuth2Purchase) - Cochez cette case pour autoriser l'application à effectuer des achats pour vous.

• L'application peut partager et annuler le partage de documents en votre nom (OAuth2share) : cochez cette case pour autoriser l'application à partager et annuler le partage de vos documents.