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.

Weitere Informationen zur Arbeit mit Onshape-Anwendungen finden Sie in der Onshape-Dokumentation für API-Entwickler.

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

Klicken Sie in der Liste links auf der Seite auf Entwickler:

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.

API-Schlüssel anzeigen

  1. Click API keys on the Developer page.
  2. View all your previously-created API keys.
    API-Schlüssel auf dem Entwicklerbildschirm

API-Schlüssel erstellen

  1. Klicken Sie auf Neuen API-Schlüssel erstellen.
    Bildschirm „Neuen API-Schlüssel erstellen“
  2. Benennen Sie den API-Schlüssel im Feld Name.
  3. Legen Sie die Berechtigungen für die Schlüssel fest. Siehe Berechtigungsbereiche unten.
  4. Klicken Sie auf die Schaltfläche API-Schlüssel erstellen.

  5. Kopieren Sie im Popup-Fenster den angezeigten API-Schlüssel und den geheimen Schlüssel, speichern Sie sie und klicken Sie dann auf die Schaltfläche Schließen.

    Sie können den geheimen Schlüssel nicht mehr erneut anzeigen. Bewahren Sie ihn deshalb an einem sicheren Ort auf!

    Geheimer, dem Benutzer angezeigter Schlüssel

API-Schlüssel löschen

  1. Klicken Sie auf das „X“-Symbol rechts neben dem API-Schlüssel, den Sie löschen möchten.
  2. Confirm that you want to delete this API key. This action cannot be undone. Click Delete to confirm.
    API-Schlüssel löschen

Die folgenden Berechtigungsbereiche sind beim Erstellen von OAuth-Anwendungen verfügbar:

  • Anwendung darf Ihre Profilinformationen lesen (OAuth2ReadPII): Markieren Sie diese Option, um der Anwendung Zugriff auf Informationen in Ihrem Profil zu gewähren.

  • Anwendung darf Ihre Dokumente lesen (OAuth2Read): Markieren Sie diese Option, um der Anwendung Lesezugriff auf Ihre Dokumente zu gewähren.

  • Anwendung darf Ihre Dokumente ändern (OAuth2Write): Markieren Sie diese Option, um der Anwendung Schreibzugriff auf Ihre Dokumente zu gewähren.

  • Anwendung darf Ihre Dokumente und Arbeitsbereiche löschen (OAuth2Delete): Markieren Sie diese Option, wenn die Anwendung Zugriff zum Löschen Ihrer Dokumente und Arbeitsbereiche erhalten soll.

  • Anwendung darf in Ihrem Namen Käufe anfordern (OAuth2Purchase): Markieren Sie diese Option, wenn mit der Anwendung etwas gekauft werden darf.

  • Anwendung darf Dokumente in Ihrem Namen teilen/nicht mehr teilen (OAuth2Share): Markieren Sie diese Option, wenn mit der Anwendung Dokumente geteilt werden sollen und die Freigabe auch wieder aufgehoben werden kann.