Disponible uniquement pour

Allow Enterprise admins to create new applications to which enterprise users can subscribe. Admins can manage and distribute these applications to specified users. Admins can also create, view, and delete API keys for users in their company or enterprise.

Pour plus d'informations sur l'utilisation des applications Onshape, consultez la Documentation pour développeurs d'API Onshape.

To navigate to your Developer settings in Onshape, click on your Account user icon (Icône de l'utilisateur du compte) in the top right corner of your Onshape window. This opens a dropdown menu. Click Company/Classroom/Enterprise settings.

Cliquez sur Développeur dans la liste sur le côté gauche de la page :

Paramètres Enterprise : Développeur

What admins can do from this screen

  • Create an internal application in the company settings without going to the App Store dev portal.

  • Manage the application internally.

  • View, create, and delete API keys for anyone in the company.

  1. Cliquez sur le lien des applications OAuth :

    Créer une nouvelle application OAuth

  2. Cliquez sur le bouton Créer une nouvelle application OAuth :

    Création d'une application OAuth

  3. Remplissez les informations comme suit (notez que des informations détaillées sont également fournies à l'écran) :

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

    • Format principal - Chaîne unique permettant d'identifier votre application qui n'est pas affichée à l'utilisateur.

    • Résumé - Informations relatives à l'application.

    • URL de redirection - URL vers laquelle vous êtes redirigé(e) après authentification.

    • Type - Type d'application. Les options sont l'application cloud intégrée, l'application cloud connectée ou l'application de bureau connectée.

    • URL OAuth - URL utilisée pour démarrer le processus OAuth depuis la page Applications Onshape.

    • 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. Utilisez le champ Rechercher des membres pour localiser et sélectionner les utilisateurs que vous souhaitez ajouter au développement et/ou au test de l'application.

  6. L'écran Autoriser l'application pour autoriser l'accès à l'application est fourni à l'utilisateur :

    Autoriser l'application

  7. Pour plus d'informations sur l'authentification de vos applications avec OAuth, consultez le Guide des API : Authentification.

All applications submitted to the Onshape App Store (Onshape Apps) must follow the instructions on the API Guide: OAuth2 page and use OAuth2 for authorization. Automation scripts (or applications not meant for the Onshape App Store) may use either OAuth2 or API Keys for authentication. OAuth2 allows applications to call Onshape APIs on behalf of the users of the application; API keys will only perform operations on behalf of the Onshape user who generated the API keys.

API keys are a useful way create small applications meant for personal use, allowing developers to avoid the overhead of the OAuth workflow.

API keys are used to authenticate an application, not its users. (OAuth2 authenticates an application and users of the application by ensuring the users are authorized to access Onshape.) Once you create an API key, it is valid only in the stack on which it was created. An API key created on companyName.onshape.com will not function on cad.onshape.com.

API keys that are not associated with a company or enterprise can be managed through the My Account - Developer page.

Affichage des clés d'API

  1. In your Company/Classroom/Enterprise Developer settings, click API keys
  2. Review the API keys available for the company.
    Clés d'API répertoriées dans l'écran du développeur

Création de clés d'API

  1. In your Company/Classroom/Enterprise Developer settings, click API keys
  2. Cliquez sur Créer une nouvelle clé d'API.
    Créer un nouvel écran de clé d'API
  3. Entrez le nom de la clé API dans le champ Nom.

  4. Assign the API key to someone in the company. You can search by name or email in the User field.

  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.

    Vous ne pourrez plus retrouver la clé secrète, alors gardez-la dans un endroit sûr !

    Clé secrète affichée à l'utilisateur

  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.
    Suppression d'une clé API

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.