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.

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

To navigate to your Developer settings in Onshape, click on your Account user icon (Icona utente account) in the top right corner of your Onshape window. This opens a dropdown menu. Click My account.

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

My Account: Developer

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 your company stack (i.e., companyName.onshape.com) will not function on the production stack (cad.onshape.com). Administrators can also manage API keys for users in their company: see Company/Classroom/Enterprise settings - Developer.

Visualizzare le chiavi API

  1. Click API keys on the Developer page.
  2. View all your previously-created API keys.
    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. Confirm that you want to delete this API key. This action cannot be undone. Click Delete to confirm.
    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.