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.

Per ulteriori informazioni su come usare le applicazioni Onshape, consulta la documentazione per gli sviluppatori delle API Onshape.

Per accedere alle impostazioni Sviluppatore in Onshape, fai clic sull'icona utente del tuo account (Icona utente account) nell'angolo superiore destro della finestra di Onshape. Si apre un menu a discesa. Fai clic su Il mio account.

Fai clic su Sviluppatore nell'elenco sul lato sinistro della pagina:

Il mio account: Sviluppatore

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 nello stack della tua azienda (ad esempio, CompanyName.onshape.com) non funzionerà nello stack di produzione (cad.onshape.com). Gli amministratori possono anche gestire le chiavi API per gli utenti della loro azienda: vedi Impostazioni Azienda/Aula/Enterprise - Sviluppatore.

Visualizzare le chiavi API

  1. Fai clic su Chiavi API nella pagina Sviluppatore.
  2. Visualizza tutte le tue chiavi API create in precedenza.
    Chiavi API elencate nella schermata dello sviluppatore

Creare chiavi API

  1. Fai clic su Crea nuova chiave API.
    Schermata Crea nuova chiave API
  2. Fornisci un nome per la chiave API nel campo Nome.
  3. Scegli le autorizzazioni per le chiavi. Vedi Ambiti di autorizzazione di seguito.
  4. Fai clic sul pulsante Crea chiave API.

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

    Non sarai più in grado di ritrovare la chiave segreta, quindi salvala in un posto sicuro!

    Chiave segreta mostrata all'utente

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.
    Eliminare una chiave api

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.