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

To create an app that opens in the Onshape UI for internal use or testing:

1. Register the app with Onshape.
2. Create an extension for the app in the Onshape UI.
3. Assign users to the app.

To publish the app to the Onshape App Store for end users:

1. Authenticate with OAuth2.
2. Create an app store entry.
3. Complete the Launch Checklist

1. Click the OAuth applications link on the Developer page to see a list of all your apps:

   

2. Click the Create new OAuth application button.

3. Fill out the form:

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

   • Primary format - String that uniquely identifies your application and is a marker for the data it might store on Onshape servers (e.g.,com.example.example). Cannot be changed after the application is registered. Not displayed to users.

   • Summary - Description of the application, shown to the user when they’re asked to grant the application permission to access their data.

   • Redirect URLs - URL to which you are redirected after authentication; the landing page of your application.

     • Your application must specify at least one URL used in the OAuth protocol exchanges.

     • This URL must also use SSL (a URL that begins with https), with two exceptions applicable for installed desktop applications: http://localhost:<port> and urn:ietf:wg:oauth:2.0:oob.

   • Type - Application type: Integrated Cloud App, Connected Cloud App, or Connected Desktop App.

   • OAuth URL - URL used to start the OAuth2 process to authenticate the user. See Developer Docs: OAuth2 for details.

     • Should contain the URL of your deployed application.

     • This is the first URL called from the Onshape Applications page.

     • The page hosted at this URL should handle the OAuth authentication. Once your application’s server has been authenticated on behalf of the user, that user should be redirected to your applications content.

     • If you have not deployed your app yet, you can leave this field blank for local work and update it later.

       All applications submitted to the Onshape App Store for public use must authenticate properly with OAuth2. See Developer Docs: OAuth2 for details.

   • 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. Copy the OAuth secret key from the window.

   You will not be able to access this secret key again. This secret is unique to you and your app. It should be protected like any sensitive password and never checked into source code.

6. The app's OAuth application entry appears with the Details tab active. Selecting the app name on the OAuth applications page now brings you to this screen.

Use the tabs on this screen to:

• Details:

  • Create a store entry for the app

  • Transfer ownership of the app

  • Delete the app

• Settings: Manage app settings

• Keys and secret:
  • Copy the OAuth client identifier key
  • Regenerate a new OAuth client secret key

• Permissions: Modify app permission scopes

• Extensions: Manage app extensions

• Onshape OAuth: Manage Onshape authentication

• External OAuth: Manage third-party authentication

See the Onshape Developer Documentation for more information, including: properly authenticating with OAuth2 and completing Launch Checklist. See the Hello World tutorial for a working example.

1. Click OAuth applications on the Developer page, then select your application.

2. Click the Extensions tab.

   

3. Click Add extension.

4. Fill out the form:

   • Name: Can be truncated in the UI if it is too long.

   • Description (optional): Does not appear in the Onshape UI, but could appear in the authentication grant process.

   • Location: Where the extension exists in the Onshape UI.

     • See Supported Locations and Contexts in the Developer Docs.

     • You can create only one element tab extension per application.

   • Context: Some locations work in the context of a selection, such as inside a Part Studio.

     • See Supported Locations and Contexts in the Developer Docs.

   • Action URL: Locations that embed a UI use the action URL to define the address of the page to display. The action URL is used to specify the REST endpoint if the location is an action (context menu, toolbar item, action in dialog etc.) and the action type is GET or POST. If the location is an action and the action is Open in new window, the action URL is the URL to open in the new window.

     • See Action URL parameters in the Developer Docs for a list of parameters that can be used in this field.

   • Action type: Applicable for locations that do not embed UIs. Supported action types are:

     • GET - This makes a GET API call using the action URL. Parameter replacement is done on the action URL.

     • POST - This makes a POST API call using the action URL and the action body as the post body. Parameter replacement is done on both the action URL and the action body.

     • Open in new window - This opens the action URL in a new browser window. Parameter replacement is done on the action URL.

   • Action body: Only applicable for POST action types. The action body is passed in a POST API call and must be in a valid JSON format.

   • Show response: This is only applicable if the action type is GET or POST. When selected, the UI waits for a response and shows the response in a dialog in the UI. The response must be in a valid JSON format.

   • Icon: The icon is displayed where the extension exist, which can include an icon in an Info panel, context menu action, toolbar button, action button in a dialog, or other supported locations.

5. Haga clic en Aceptar.

For more information on creating and managing Onshape applications, please see the Onshape Developer Docs. Please see the Hello World tutorial for a working example.

Admins can add internal users to applications for testing before submitting to the Onshape App Store. Users added here automatically see the associated app extensions in their Onshape UI, without having to subscribe via the app store.

1. Once your app is registered, click Applications in the left pane.

2. Select the application in the list.

   

3. Begin typing the name or email of a user, team, or alias in the Add users or teams field, and select a result from the list. The admin who created the app is automatically in the Users list. Continue adding names or emails.

   

4. Click the Add button.

Light users cannot be added to applications.

To remove a user, alias, or team from the app, click its X icon in the Remove column.

1. En la configuración de desarrollador, haga clic en Aplicaciones de OAuth.
2. Haga clic en el nombre de la aplicación que desea transferir.
3. Haga clic en el botón Transferir propiedad de la pestaña Detalles. Se abre el cuadro de diálogo Transferir.

   

4. Seleccione una opción para transferir la aplicación a una persona o empresa.
5. Para transferir a una persona, introduzca el nombre o el correo electrónico del nuevo propietario en el campo de búsqueda. Para transferir la propiedad a una empresa, seleccione una opción del menú desplegable.
6. Haga clic en Transferir propiedad. La aplicación se eliminará de su lista de aplicaciones de OAuth.
   • If the app is transferred to an individual account, they receive an email notification and the app appears in their Onshape Developer Portal.
   • If the app is transferred to someone in a Company/Classroom/Enterprise, all Admins receive an email notification and the app appears in their Developer Settings.

El consumo y la facturación futuros de las llamadas a la API se atribuirán al nuevo propietario. Consulte Límites de la API para obtener más información.

Before submitting an app to the Onshape App Store, see the Onshape Developer Documentation for requirements, including properly authenticating with OAuth2 and completing Launch Checklist.

To review, edit, or delete an existing Onshape App Store entry, click Store entries in your Developer settings, then select the entry to modify.

To create a new store entry for an OAuth application:

1. En la configuración de desarrollador, haga clic en Aplicaciones de OAuth.

2. Click the app name in the list.

3. Click Create store entry on the app's Details page.

   

4. Fill out the form:

   

   • Name - Automatically set from the app name provided during registration.

   • Summary - Automatically set from the summary provided during registration.

   • Type - Application type: Integrated Cloud App, Connected Cloud App, or Connected Desktop App. This should match the Type that was selected when registering the OAuth application.

   • Category - Select the appropriate category for your app.

   • Team Visibility - Choose to make the private app store entry visible to no internal users (default), all internal users, or specific teams.

   • Description - User-facing description of the application. Limited formatting allowed.

   • Support URL - URL or email users of your app should be directed to for assistance. This must be actively monitored.

   • Support Email - Email that should receive app subscription notifications. This must be actively monitored.

   • Vendor - Your company name.

   • Version - Current version of this application.

   • Images - Optionally upload summary, hero, and other images.

5. Haga clic en Crear.

The application appears in the Onshape App Store as private. It is viewable only to you and any internal teams specified in Team Visibility settings. To make the app public, see the Launch Checklist next.

1. Click Developer in the left pane of your company settings.
2. If your app has an Onshape App Store entry, delete that first:
   1. Click Store entries on the Developer page.
   2. Click the store entry to delete.
   3. Click Delete store entry on the Details tab.
      
   4. Click Delete again to confirm.
   5. Click Developer in the left pane or breadcrumbs to return the Developer landing page.
3. Click OAuth applications in the Developer settings.
4. Click the application to delete.
5. Click Delete application on the Details tab.
   
6. Click Delete again to confirm.

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.

   You will not be able to access this secret key again. This secret is unique to you and your app. It should be protected like any sensitive password and never checked into source code.

   

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.