Impostazioni Azienda/Aula/Enterprise - Sviluppatore

Per creare un'app che si apra nell'interfaccia utente di Onshape per uso interno o per test:

1. Registra l'app in Onshape.
2. Crea un'estensione per l'app nell'interfaccia utente di Onshape.
3. Assegna utenti all'app.

Per pubblicare l'app sull'App Store Onshape per gli utenti finali:

1. Effettua l'autenticazione con OAuth2.
2. Crea una voce nell'App Store.
3. Completa l'elenco di controllo per il lancio

1. Fai clic sul collegamento Applicazioni OAuth nella pagina Sviluppatore per visualizzare un elenco di tutte le tue app:

   

2. Fai clic sul pulsante Crea nuova applicazione OAuth.

3. Compila il modulo:

   • Nome: nome dell'applicazione visualizzata agli utenti.

   • Formato principale: stringa che identifica in modo univoco la tua applicazione e funge da marcatore per i dati che potrebbe memorizzare sui server Onshape (ad esempio, com.example.example). Non può essere modificata dopo la registrazione dell'applicazione e non viene mostrata gli utenti.

   • Riepilogo: descrizione dell'applicazione, mostrata all'utente quando gli viene chiesto di concedere all'applicazione l'autorizzazione ad accedere ai dati.

   • URL di reindirizzamento: URL che si apre dopo l'autenticazione; la pagina di destinazione della tua applicazione.

     • La tua applicazione deve specificare almeno un URL utilizzato negli scambi del protocollo OAuth.

     • Questo URL deve inoltre utilizzare il protocollo SSL (un URL che inizia con https), con due eccezioni applicabili alle applicazioni desktop installate: http://localhost:<port> e urn:ietf:wg:oauth:2.0:oob.

   • Tipo: tipo di applicazione: App cloud integrata, App cloud connessa oppure App desktop connessa.

   • URL OAuth: URL utilizzato per avviare il processo OAuth2 di autenticazione dell'utente. Per i dettagli, consulta Documentazione per gli sviluppatori: OAuth2.

     • Dovrebbe contenere l'URL della tua applicazione implementata.

     • Questo è il primo URL richiamato dalla pagina delle applicazioni Onshape.

     • La pagina ospitata a questo URL deve gestire l'autenticazione OAuth. Una volta che il server della tua applicazione è stato autenticato per conto dell'utente, quest'ultimo deve essere reindirizzato ai contenuti della tua applicazione.

     • Se non hai ancora implementato la tua app, puoi lasciare questo campo vuoto per il lavoro in locale e aggiornarlo in un secondo momento.

       Tutte le applicazioni inviate all'App Store Onshape per uso pubblico devono autenticarsi correttamente con OAuth2. Per i dettagli, consulta Documentazione per sviluppatori: OAuth2.

   • Impostazioni

     • Supporta la collaborazione: seleziona la casella se desideri collaborare con altri utenti durante lo sviluppo dell'applicazione.

   • Autorizzazioni: vedi Ambiti autorizzazioni di seguito.

4. Fai clic su Crea applicazione.

5. Copia la chiave segreta OAuth dalla finestra.

   Non potrai più accedere nuovamente a questa chiave segreta. Questa codice segreto è unico per te e per la tua app, deve essere protetto come qualsiasi password riservata e non deve essere mai inserito nel codice sorgente.

6. La voce dell'applicazione OAuth dell'app è visualizzata con la scheda Dettagli attiva. Selezionando il nome dell'app nella pagina delle applicazioni OAuth si viene ora indirizzati a questa schermata.

Usa le schede di questa pagina per:

• Dettagli:

  • Creare una voce nello store per l'app

  • Trasferire la proprietà dell'app

  • Eliminare l'app

• Impostazioni: gestire le impostazioni dell'app

• Chiavi e codici segreti:
  • Copiare la chiave dell'Identificatore cliente OAuth
  • Rigenerare una nuova chiave del codice segreto cliente OAuth

• Autorizzazioni: modificare gli ambiti di autorizzazione dell'app

• Estensioni: gestire le estensioni delle app

• Onshape OAuth: gestire l'autenticazione Onshape

• OAuth esterno: gestire l'autenticazione di terze parti

Consulta la Documentazione per sviluppatori di Onshape per ulteriori informazioni, tra cui: la corretta autenticazione con OAuth2 e il completamento dell'elenco di controllo per il lancio. Consulta il tutorial Hello World per un esempio pratico.

1. Fai clic su Applicazioni OAuth nella pagina Sviluppatore, quindi seleziona la tua applicazione.

2. Fai clic sulla scheda Estensioni.

   

3. Fai clic su Aggiungi estensione.

4. Compila il modulo:

   • Nome: può essere troncato nell'interfaccia utente se troppo lungo.

   • Descrizione (facoltativa): non viene visualizzata nell'interfaccia utente di Onshape, ma potrebbe apparire nel processo di autorizzazione dell'autenticazione.

   • Posizione: indica dove si trova l'estensione nell'interfaccia utente di Onshape.

     • Consulta Posizioni e contesti supportati nella documentazione per gli sviluppatori.

     • Puoi creare solo un'estensione per la scheda degli elementi per applicazione.

   • Contesto: alcune posizioni funzionano nel contesto di una selezione, ad esempio all'interno di un Part Studio.

     • Consulta Posizioni e contesti supportati nella documentazione per gli sviluppatori.

   • URL azione: le posizioni che incorporano un'interfaccia utente utilizzano l'URL azione per definire l'indirizzo della pagina da visualizzare. L'URL azione viene utilizzato per specificare l'endpoint REST se la posizione è un'azione (menu contestuale, elemento della barra degli strumenti, azione in una finestra di dialogo ecc.) e il tipo di azione è GET o POST. Se la posizione è un'azione e l'azione è Apri in una nuova finestra, l'URL azione è l'URL da aprire nella nuova finestra.

     • Consulta Parametri dell'URL azione nella documentazione per gli sviluppatori per un elenco di parametri che possono essere utilizzati in questo campo.

   • Tipo di azione: applicabile per le posizioni che non incorporano interfacce utente. I tipi di azione supportati sono:

     • GET: effettua una chiamata API GET utilizzando l'URL azione. La sostituzione dei parametri viene effettuata sull'URL azione.

     • POST: effettua una chiamata API POST utilizzando l'URL azione e il corpo azione come corpo della richiesta. La sostituzione dei parametri viene effettuata sia sull'URL azione che sul corpo azione.

     • Apri in una nuova finestra: apre l'URL azione in una nuova finestra del browser. La sostituzione dei parametri viene effettuata sull'URL azione.

   • Corpo azione: applicabile solo ai tipi di azione POST. Il corpo azione viene passato in una chiamata API POST e deve essere in un formato JSON valido.

   • Mostra risposta: applicabile solo se il tipo di azione è GET o POST. Quando è selezionata, l'interfaccia utente attende una risposta e la mostra in una finestra di dialogo nell'interfaccia utente. La risposta deve essere in un formato JSON valido.

   • Icona: l'icona viene visualizzata dove esiste l'estensione, ad esempio un'icona in un pannello delle informazioni, un'azione del menu contestuale, un pulsante nella barra degli strumenti, un pulsante di azione in una finestra di dialogo o altre posizioni supportate.

5. Fai clic su OK.

Per ulteriori informazioni sulla creazione e la gestione delle applicazioni Onshape, consulta la Documentazione per gli sviluppatori di Onshape. Consulta il tutorial Hello World per un esempio pratico.

Gli amministratori possono aggiungere utenti interni alle applicazioni per effettuare dei test prima di inviarle all'App Store Onshape. Gli utenti aggiunti qui visualizzeranno automaticamente le estensioni delle app associate nella loro interfaccia utente di Onshape, senza dover effettuare l'abbonamento tramite l'App Store.

1. Una volta registrata la tua app, fai clic su Applicazioni nel riquadro a sinistra.

2. Seleziona l'applicazione nell'elenco.

   

3. Inizia a digitare il nome o l'indirizzo email di un utente, team o alias nel campo Aggiungi utenti o team e seleziona un risultato dall'elenco. L'amministratore che ha creato l'app viene inserito automaticamente nell'elenco Utenti. Continua ad aggiungere nomi o indirizzi email.

   

4. Fai clic sul pulsante Aggiungi.

Non è possibile aggiungere utenti Light alle applicazioni.

Per rimuovere un utente, un alias o un team dall'app, fai clic sulla relativa icona X nella colonna Rimuovi.

1. Nelle tue impostazioni per sviluppatori, fai clic su Applicazioni OAuth.
2. Fai clic sul nome dell'app da trasferire.
3. Fai clic sul pulsante Trasferisci proprietà nella scheda Dettagli. Si apre la finestra di dialogo Trasferisci.

   

4. Seleziona un'opzione per trasferire l'app a una persona, un'azienda o un'enterprise.
5. Per il trasferimento a una persona fisica, inserisci il nome o l'indirizzo email del nuovo proprietario nel campo di ricerca. Per trasferire la proprietà a una società o enterprise, seleziona un'opzione nel menu a discesa.
6. Fai clic su Trasferisci proprietà. L'applicazione è rimossa dall'elenco delle tue app OAuth.
   • Se l'app viene trasferita a un account individuale, questo riceverà una notifica via email e l'app sarà visualizzata nel Portale sviluppatori Onshape dell'account.
   • Se l'app viene trasferita a un utente di un'azienda/aula/Enterprise, tutti gli amministratori riceveranno una notifica via email e l'app sarà visualizzata nelle Impostazioni sviluppatore dell'utente.

Il consumo e la fatturazione futuri delle chiamate API saranno attribuiti al nuovo proprietario. Vedi Limiti delle API per i dettagli.

Prima di inviare un'app all'App Store Onshape, consulta la Documentazione per sviluppatori di Onshape per verificare i requisiti, tra cui la corretta autenticazione con OAuth2 e il completamento dell'elenco di controllo per il lancio.

Per rivedere, modificare o eliminare una voce esistente nell'App Store Onshape, fai clic su Voci dello store nelle impostazioni sviluppatore, quindi seleziona la voce da modificare.

Per creare una nuova voce store per un'applicazione OAuth:

1. Nelle tue impostazioni per sviluppatori, fai clic su Applicazioni OAuth.

2. Fai clic sul nome dell'app nell'elenco.

3. Fai clic su Crea voce store nella pagina Dettagli dell'app.

   

4. Compila il modulo:

   

   • Nome: impostato automaticamente in base al nome dell'app fornito durante la registrazione.

   • Riepilogo: impostato automaticamente dal riepilogo fornito durante la registrazione.

   • Tipo: tipo di applicazione: App cloud integrata, App cloud connessa o App desktop connessa. Il tipo deve corrispondere al Tipo selezionato al momento della registrazione dell'applicazione OAuth.

   • Categoria: seleziona la categoria appropriata per la tua app.

   • Visibilità del team: scegli se rendere la voce privata dell'App Store visibile a nessun utente interno (impostazione predefinita), a tutti gli utenti interni o a team specifici.

   • Descrizione: descrizione dell'applicazione visibile all'utente. È consentita una formattazione limitata.

   • URL di supporto: l'URL o l'indirizzo email a cui gli utenti della tua app devono essere indirizzati per ricevere assistenza. Deve essere monitorato regolarmente.

   • Email di supporto: indirizzo email che deve ricevere le notifiche degli abbonamenti all'app. Deve essere monitorato attivamente.

   • Rivenditore: il nome della tua azienda.

   • Versione: la versione corrente di questa applicazione.

   • Immagini: facoltativamente, carica riepilogo, hero e altre immagini.

5. Fai clic su Crea.

L'applicazione appare nell'App Store Onshape come privata. È visibile solo a te e agli eventuali team interni specificati nelle impostazioni di Visibilità team. Per rendere pubblica l'app, consulta successivamente l'elenco di controllo per il lancio.

1. Fai clic su Sviluppatore nel pannello delle impostazioni aziendali a sinistra.
2. Se la tua app esiste già in una voce dell'App Store Onshape, prima eliminala:
   1. Fai clic su Voci dello store nella pagina Sviluppatore.
   2. Fai clic sulla voce dello store per eliminarla.
   3. Fai clic su Elimina voce dello store nella scheda Dettagli .
      
   4. Fai di nuovo clic su Elimina per confermare.
   5. Fai clic su Sviluppatore nel pannello a sinistra o sul percorso di navigazione per tornare alla pagina di destinazione dello sviluppatore.
3. Fai clic su Applicazioni OAuth nelle impostazioni Sviluppatore.
4. Fai clic sull'applicazione per eliminarla.
5. Fai clic su Elimina applicazione nella scheda Dettagli.
   
6. Fai di nuovo clic su Elimina per confermare.

Tutte le applicazioni inviate all'App Store di Onshape (Onshape Apps) devono seguire le istruzioni nella guida API: pagina OAuth2 e utilizzare OAuth2 per l'autorizzazione. Gli script di automazione (o le applicazioni non pensate per l'App Store di Onshape) possono utilizzare OAuth2 o chiavi API per l'autenticazione. OAuth2 consente alle applicazioni di chiamare le API Onshape per conto degli utenti dell'applicazione; le chiavi API eseguiranno operazioni solo per conto dell'utente Onshape che ha generato le chiavi API.

Le chiavi API sono un modo utile di creare piccole applicazioni destinate all'uso personale, consentendo agli sviluppatori di evitare il sovraccarico del flusso di lavoro OAuth.

Le chiavi API sono utilizzate per autenticare un'applicazione, non i suoi utenti. (OAuth2 autentica un'applicazione e gli utenti dell'applicazione, garantendo che gli utenti siano autorizzati ad accedere a Onshape.) Una volta creata una chiave API, questa è valida solo nello stack in cui è stata creata. Una chiave API creata su CompanyName.onshape.com non funzionerà su cad.onshape.com.

Le chiavi API non associate a un'azienda o Enterprise sono gestibili tramite la pagina Il mio account - Sviluppatore.

Visualizzare le chiavi API

1. Nelle tue impostazioni Azienda/Aula/Enterprise Developer, fai clic su Chiavi API
2. Esamina le chiavi API disponibili per l'azienda.
   
   

Creare chiavi API

1. Nelle tue impostazioni Azienda/Aula/Enterprise Developer, fai clic su Chiavi API
2. Fai clic su Crea nuova chiave API.
   
3. Fornisci un nome per la chiave API nel campo Nome.

4. Assegna la chiave API a un utente dell'azienda. Puoi cercare per nome o email nel campo Utente.

5. Scegli le autorizzazioni per le chiavi. Vedi Ambiti di autorizzazione di seguito.
6. Fai clic sul pulsante Crea chiave API.

7. Nella finestra pop-up, copia la chiave API e la chiave segreta visualizzate, salvale da qualche parte, quindi fai clic sul pulsante Chiudi.

   Non potrai più accedere nuovamente a questa chiave segreta. Questa codice segreto è unico per te e per la tua app, deve essere protetto come qualsiasi password riservata e non deve essere mai inserito nel codice sorgente.

   

8. Per informazioni sull'autenticazione delle applicazioni con le chiavi API, consulta la Guida API: autenticazione.

Eliminare le chiavi API

1. Fai clic sull'icona X a destra della chiave API che desideri eliminare.
2. Conferma che vuoi eliminare questa chiave API per tutti gli utenti. Questa azione non è annullabile. Fai clic su Elimina per confermare.
   

I seguenti ambiti di autorizzazione sono disponibili durante la creazione di applicazioni OAuth:

• L'applicazione può leggere le informazioni del tuo profilo (OAuth2ReadPII): seleziona l'opzione per consentire all'applicazione di accedere alle informazioni sul tuo profilo.

• L'applicazione può leggere i tuoi documenti (OAuth2Read): seleziona l'opzione per consentire all'applicazione di accedere in lettura ai tuoi documenti.

• L'applicazione può scrivere sui tuoi documenti (OAuth2Write): seleziona l'opzione per consentire all'applicazione di accedere in scrittura ai tuoi documenti.

• L'applicazione può eliminare i tuoi documenti e le tue aree di lavoro (OAuth2Delete): seleziona l'opzione per consentire all'applicazione di accedere ed eliminare i documenti e le aree di lavoro.

• L'applicazione può richiedere acquisti per tuo conto (OAuth2Purchase): seleziona l'opzione per consentire all'applicazione di effettuare acquisti per te.

• L'applicazione può condividere e interrompere la condivisione di documenti per tuo conto (OAuth2Share): seleziona l'opzione per consentire all'applicazione la possibilità di condividere e annullare la condivisione dei tuoi documenti.