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.

Para obtener más información sobre cómo trabajar con las aplicaciones de Onshape, consulte la Documentación para desarrolladores de la API de Onshape.

To navigate to your Developer settings in Onshape, click on your Account user icon (Ícono de usuario de cuenta) in the top right corner of your Onshape window. This opens a dropdown menu. Click My account.

Haga clic en Desarrollador en la lista del margen izquierdo de la página:

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.

Visualización de claves de API

  1. Click API keys on the Developer page.
  2. View all your previously-created API keys.
    Las claves de API aparecen en la pantalla del desarrollador

Creación de claves de API

  1. Haga clic en Crear nueva clave de API.
    Pantalla Crear una nueva clave de API
  2. Proporcione un nombre para la clave de API en el campo Nombre.
  3. Elija los permisos para las claves. Consulte los Alcances de los permisos a continuación.
  4. Haga clic en el botón Crear clave de API.

  5. En la ventana emergente, copie la clave de API y la clave secreta que se muestran, guárdelas en algún lugar y, luego, haga clic en el botón Cerrar.

    No volverá a recibir la clave secreta, ¡así que guárdela en un lugar seguro!

    Clave secreta que se muestra al usuario

Eliminación de claves de API

  1. Haga clic en el ícono de la «X» situado a la derecha de la clave de API que quiere eliminar.
  2. Confirm that you want to delete this API key. This action cannot be undone. Click Delete to confirm.
    Eliminación de claves de API

Los siguientes alcances de permisos están disponibles al crear aplicaciones de OAuth:

  • La aplicación puede leer la información de su perfil (OAuth2ReadPII): active esta opción para permitir a la aplicación acceder a la información de su perfil.

  • La aplicación puede leer sus documentos (OAuth2Read): active este opción para otorgar a la aplicación acceso de lectura a sus documentos.

  • La aplicación puede escribir en sus documentos (OAuth2Write): active esta opción para otorgar a la aplicación acceso de escritura a sus documentos.

  • La aplicación puede eliminar sus documentos y áreas de trabajo (OAuth2Delete): active esta opción a para permitir a la aplicación acceder a sus documentos y áreas de trabajo y eliminarlos.

  • La aplicación puede solicitar compras en su nombre (OAuth2Purchase): active esta opción para que la aplicación pueda realizar compras por usted.

  • La aplicación puede compartir y dejar de compartir documentos en su nombre (OAuth2Share): active esta opción para permitir que la aplicación pueda compartir y dejar de compartir sus documentos.