Configuración de compañía/aula/empresa: Desarrollador

1. Haga clic en el vínculo Aplicaciones de OAuth:

   

2. Haga clic en el botón Crear nueva 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:

   

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

Todas las solicitudes enviadas a Onshape App Store (Onshape Apps) deben seguir las instrucciones de la página Guía de API: OAuth2 y utilizar OAuth2 para la autorización. Los scripts de automatización (o las aplicaciones no destinadas a Onshape App Store) pueden usar OAuth2 o claves de API para la autenticación. OAuth2 permite a las aplicaciones llamar a las API de Onshape en nombre de los usuarios de la aplicación; las claves de API solo realizarán operaciones en nombre del usuario de Onshape que las generó.

Las claves de API son una forma útil de crear pequeñas aplicaciones para uso personal, lo que permite a los desarrolladores evitar la sobrecarga del flujo de trabajo de OAuth.

Las claves de API se utilizan para autenticar una aplicación, no a sus usuarios. (OAuth2 autentica una aplicación y a los usuarios de la aplicación al garantizar que los usuarios estén autorizados a acceder a Onshape). Una vez creada una clave de API, solo es válida en la pila en la que se creó. Una clave de API creada en nombredelaCompañía.onshape.com no funcionará en cad.onshape.com.

Las claves de API que no están asociadas a una compañía o empresa se pueden administrar a través de la página Mi cuenta: Desarrollador.

Visualización de claves de API

1. En la configuración de compañía, aula o empresa para desarrolladores, haga clic en Claves de API
2. Revise las claves de API disponibles para la compañía.
   
   

Creación de claves de API

1. En la configuración de compañía, aula o empresa para desarrolladores, haga clic en Claves de API
2. Haga clic en Crear nueva clave de API.
   
3. Proporcione un nombre para la clave de API en el campo Nombre.

4. Asigne la clave de API a alguien de la empresa. Puede buscar por nombre o correo electrónico en el campo Usuario.

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!

   

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.
   

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.