Solo disponible para

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.

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 Company/Classroom/Enterprise settings.

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

Configuración de Enterprise: desarrollador

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. Haga clic en el vínculo Aplicaciones de OAuth:

    Crear nueva aplicación de OAuth

  2. Haga clic en el botón Crear nueva aplicación de OAuth:

    Creación de una aplicación de OAuth

  3. Complete la información de la siguiente manera (tenga en cuenta que también se proporciona información detallada en la pantalla):

    • Nombre: es el nombre de la aplicación que se muestra a los usuarios.

    • Formato principal: es una cadena única que sirve para identificar la aplicación que no se muestra al usuario.

    • Resumen: es la información de la aplicación.

    • URL de redireccionamiento: es la URL a la que se le redirige después de la autenticación.

    • Tipo: es el tipo de aplicación. Las opciones son Aplicación de nube integrada, Aplicación de nube conectada o Aplicación de escritorio conectada.

    • URL de OAuth: es la URL utilizada para iniciar el proceso de OAuth desde la página Aplicaciones de Onshape.

    • Ajustes

      • Admite la colaboración: active esta opción si quiere colaborar con otros usuarios cuando desarrolle la aplicación.

    • Permisos: consulte los Alcances de los permisos a continuación.

  4. Haga clic en Crear aplicación.

  5. Utilice el campo Buscar miembros para encontrar y seleccionar usuarios a fin de que participen en el desarrollo o las pruebas de la aplicación.

  6. Se proporciona al usuario la pantalla Autorizar la aplicación para permitir el acceso a la aplicación:

    Autorizar aplicación

  7. Para obtener información sobre cómo autenticar sus aplicaciones con OAuth, consulte la Guía de API: Autenticación.

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.

Visualización de claves de API

  1. In your Company/Classroom/Enterprise Developer settings, click API keys
  2. Review the API keys available for the company.
    Las claves de API aparecen en la pantalla del desarrollador

Creación de claves de API

  1. In your Company/Classroom/Enterprise Developer settings, click API keys
  2. Haga clic en Crear nueva clave de API.
    Pantalla Crear una nueva clave de API
  3. Proporcione un nombre para la clave de API en el campo Nombre.

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

  5. Elija los permisos para las claves. Consulte los Alcances de los permisos a continuación.
  6. Haga clic en el botón Crear clave de API.

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

  8. Para obtener información sobre cómo autenticar sus aplicaciones con claves de API, consulte la Guía de API: Autenticación.

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. Confirme que quiere eliminar esta clave de API para todos los usuarios. Esta acción no se puede deshacer. Haga clic en Eliminar para confirmar.
    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.