Company/Classroom/Enterprise Settings - Developer

1. Klicken Sie auf den Link OAuth-Anwendungen:

   

2. Klicken Sie auf die Schaltfläche Neue OAuth-Anwendung erstellen:

   

3. Füllen Sie die Informationen wie folgt aus (beachten Sie, dass detaillierte Informationen auch auf dem Bildschirm angezeigt werden):

   • Name: Name der Anwendung, die Benutzern angezeigt wird

   • Primäres Format: eindeutige Zeichenfolge zur Identifizierung Ihrer Anwendung, die dem Benutzer nicht angezeigt wird

   • Zusammenfassung: Informationen zur Anwendung

   • Weiterleitungs-URLs: Internetadresse, zu der Sie nach der Authentifizierung weitergeleitet werden

   • Typ: Anwendungstyp, Optionen: Integrierte Cloud-App, Connected Cloud-App oder Connected Desktop App

   • OAuth-URL: verwendete Internetadresse, um den OAuth-Prozess von der Onshape-Anwendungsseite aus zu starten

   • Einstellungen

     • Unterstützt Zusammenarbeit: aktivieren, wenn Sie bei der Entwicklung der Anwendung mit anderen Benutzern zusammenarbeiten möchten

   • Berechtigungen: siehe Berechtigungsbereiche unten

4. Klicken Sie auf Anwendung erstellen.

5. Suchen Sie im Mitglieder-Feld die Benutzer, mit denen Sie bei der Anwendungsentwicklung und/oder beim Testen zusammenarbeiten möchten, und wählen Sie diese aus.

6. Benutzer sehen dann den Bildschirm „Anwendung autorisieren“, um Zugriff auf die Anwendung zu gewähren:

   

7. Informationen zur Authentifizierung Ihrer Anwendungen mit OAuth finden Sie im API-Leitfaden: Authentifizierung.

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.

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 companyName.onshape.com will not function on cad.onshape.com.

API keys that are not associated with a company or enterprise can be managed through the My Account - Developer page.

API-Schlüssel anzeigen

1. In your Company/Classroom/Enterprise Developer settings, click API keys
2. Review the API keys available for the company.
   
   

API-Schlüssel erstellen

1. In your Company/Classroom/Enterprise Developer settings, click API keys
2. Klicken Sie auf Neuen API-Schlüssel erstellen.
   
3. Benennen Sie den API-Schlüssel im Feld Name.

4. Assign the API key to someone in the company. You can search by name or email in the User field.

5. Legen Sie die Berechtigungen für die Schlüssel fest. Siehe Berechtigungsbereiche unten.
6. Klicken Sie auf die Schaltfläche API-Schlüssel erstellen.

7. 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!

   

8. Informationen zur Authentifizierung Ihrer Anwendungen mit API-Schlüsseln finden Sie im API-Leitfaden: Authentifizierung.

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. Bestätigen Sie, dass Sie diesen API-Schlüssel für alle Benutzer löschen möchten. Diese Aktion kann nicht rückgängig gemacht werden. Klicken Sie zur Bestätigung auf 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.