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.

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 My account.

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

My Account: Developer

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 your company stack (i.e., companyName.onshape.com) will not function on the production stack (cad.onshape.com). Administrators can also manage API keys for users in their company: see Company/Classroom/Enterprise settings - Developer.

Affichage des clés d'API

  1. Click API keys on the Developer page.
  2. View all your previously-created API keys.
    Clés d'API répertoriées dans l'écran du développeur

Création de clés d'API

  1. Cliquez sur Créer une nouvelle clé d'API.
    Créer un nouvel écran de clé d'API
  2. Entrez le nom de la clé API dans le champ Nom.
  3. Choisissez les autorisations pour les clés. Consultez la section Étendue des autorisations ci-dessous.
  4. Cliquez sur le bouton Créer une clé d'API.

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

Suppression des clés d'API

  1. Cliquez sur l'icône « X » à droite de la clé d'API que vous souhaitez supprimer.
  2. Confirm that you want to delete this API key. This action cannot be undone. Click Delete to confirm.
    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.