Company-/Kurs-/Enterprise-Einstellungen – Entwickler

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.

Für alle im Onshape App Store (Onshape Apps) eingereichten Anwendungen müssen den Anleitungen auf der Seite API Guide: OAuth2 befolgt und OAuth2 zur Autorisierung verwendt werden. Automatisierungsskripte (oder Anwendungen, die nicht für den Onshape App Store gedacht sind), können entweder OAuth2- oder API-Schlüssel für die Authentifizierung verwenden. Bei OAuth2 können Anwendungen Onshape-APIs für die Benutzer aufrufen. API-Schlüssel führen hingegen nur Operationen für den Onshape-Benutzer aus, der die API-Schlüssel generiert hat.

API-Schlüssel sind eine nützliche Methode, um kleine Anwendungen für den persönlichen Gebrauch zu erstellen, sodass Entwickler den Aufwand des OAuth-Workflows vermeiden können.

API-Schlüssel werden verwendet, um eine Anwendung zu authentifizieren, nicht ihre Benutzer. (OAuth2 authentifiziert eine Anwendung und den Benutzer der Anwendung, indem sichergestellt wird, dass die Benutzer für den Zugriff auf Onshape autorisiert sind.) Wenn Sie einen API-Schlüssel erstellt haben, ist er nur für den Stack gültig, auf dem er erstellt wurde. So funktioniert z. B. ein auf companyName.onshape.com erstellter API-Schlüssel nicht auf cad.onshape.com.

API-Schlüssel, die nicht einer Company oder einem Enterprise zugeordnet sind, können über die Seite Mein Konto – Entwickler verwaltet werden.

API-Schlüssel anzeigen

1. Klicken Sie in den Einstellungen für Company/Kurs/Enterprise – Entwickler auf API-Schlüssel.
2. Überprüfen Sie die für die Company verfügbaren API-Schlüssel.
   
   

API-Schlüssel erstellen

1. Klicken Sie in den Einstellungen für Company/Kurs/Enterprise – Entwickler auf API-Schlüssel.
2. Klicken Sie auf Neuen API-Schlüssel erstellen.
   
3. Benennen Sie den API-Schlüssel im Feld Name.

4. Weisen Sie den API-Schlüssel jemandem in der Company zu. Sie können im Feld Benutzer nach dem Namen oder der E-Mail-Adresse suchen.

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.