Company-/Kurs-/Enterprise-Einstellungen – Entwickler

Folgende Schritte sind notwendig, wenn Sie eine App erstellen möchten, die in der Onshape-Benutzeroberfläche für interne Zwecke oder zum Testen geöffnet wird:

1. Registrieren Sie die App bei Onshape.
2. Erstellen Sie eine Erweiterung für die App in der Onshape-Benutzeroberfläche.
3. Weisen Sie die App-Benutzer zu.

Wenn Sie die App im Onshape App Store für Endbenutzer veröffentlichen möchten, sind dagegen diese Schritte erforderlich:

1. Authentifizieren Sie sich mit OAuth2.
2. Erstellen Sie eine Einreichung für den App-Store.
3. Füllen Sie die Launch-Checkliste aus.

1. Klicken Sie auf der Entwicklerseite auf den Link OAuth-Anwendungen, um eine Liste all Ihrer Apps zu sehen:

   

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

3. Füllen Sie das Formular aus:

   • Name: Name der Anwendung, die Benutzern angezeigt wird

   • Primäres Format: Zeichenfolge, die Ihre Anwendung eindeutig identifiziert und an der sich die Daten erkennen lassen, die die App möglicherweise auf Onshape-Servern speichert (z. B. com.beispiel.beispiel). Wurde die App registriert, kann dies nicht mehr geändert werden. Wird Benutzern nicht angezeigt.

   • Zusammenfassung: Beschreibung der angezeigten Anwendung für Benutzer, wenn sie gebeten werden, der Anwendung den Zugriff auf die eigenen Daten zu erlauben.

   • Weiterleitungs-URLs: URL, zu der Sie nach der Authentifizierung weitergeleitet werden (die Landing-Page Ihrer Anwendung).

     • Ihre Anwendung muss mindestens eine URL angeben, die beim OAuth-Protokollaustausch verwendet wird.

     • Diese URL muss auch SSL verwenden (eine URL, die mit https beginnt). Es gibt allerdings zwei Ausnahmen für installierte Desktop-Anwendungen: http://localhost: <port>und urn:ietf:wg:oauth:2.0:oob.

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

   • OAuth-URL: die URL, die verwendet wird, um den OAuth2-Prozess zur Benutzerauthentifizierung zu starten. Weitere Informationen finden Sie in der Entwicklerdokumentation unter „OAuth2“.

     • Sollte die URL Ihrer bereitgestellten Anwendung enthalten.

     • Dies ist die erste URL, die von der Onshape-Anwendungsseite aufgerufen wird.

     • Die Seite, die unter dieser URL gehostet wird, sollte die OAuth-Authentifizierung verarbeiten. Sobald der Server Ihrer Anwendung im Auftrag des Benutzers authentifiziert wurde, sollte dieser Benutzer zu Ihrer Anwendung umgeleitet werden.

     • Wenn Sie Ihre App noch nicht bereitgestellt haben, können Sie dieses Feld für die Arbeit an einem lokalen Rechner leer lassen und es später aktualisieren.

       Alle Anwendungen, die im Onshape App Store zur öffentlichen Verwendung eingereicht werden, müssen korrekt mit OAuth2 authentifiziert werden. Weitere Informationen finden Sie in der Entwicklerdokumentation unter „OAuth2“.

   • 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. Kopieren Sie den geheimen OAuth-Schlüssel aus dem Fenster.

   Sie werden nicht wieder auf diesen geheimen Schlüssel zugreifen können. Dieses Geheimnis gilt nur für Sie und Ihre App. Es sollte wie jedes vertrauliche Passwort geschützt und niemals in den Quellcode integriert werden.

6. Der OAuth-Anwendungseintrag der App wird angezeigt, während die Registerkarte Details aktiv ist. Wenn Sie den Namen der App auf der OAuth-Anwendungsseite auswählen, gelangen Sie jetzt zu diesem Bildschirm.

Mit den Registerkarten auf diesem Bildschirm haben Sie folgende Möglichkeiten:

• Details:

  • Store-Eintrag für die App erstellen

  • Eigentümerschaft an der App übertragen

  • App löschen

• Einstellungen: App-Einstellungen verwalten

• Schlüssel und Geheimnis:
  • OAuth-Client-Identifikationsschlüssel kopieren
  • Neuen geheimen OAuth-Client-Schlüssel erzeugen

• Berechtigungen: Berechtigungsbereiche der App ändern

• Erweiterungen: App-Erweiterungen verwalten

• Onshape OAuth: Onshape-Authentifizierung verwalten

• Externes OAuth: Drittanbieter-Authentifizierung verwalten

Weitere Informationen finden Sie in der Onshape-Dokumentation für Entwickler, einschließlich: korrekte Authentifizierung mit OAuth2 und Ausfüllen der Launch-Checkliste. Ein funktionierendes Beispiel finden Sie im Tutorial Hello World.

1. Klicken Sie auf der Entwicklerseite auf OAuth-Anwendungen und wählen Sie dann Ihre Anwendung aus.

2. Klicken Sie auf die Registerkarte Erweiterungen.

   

3. Klicken Sie auf Erweiterung hinzufügen.

4. Füllen Sie das Formular aus:

   • Name: kann in der Benutzeroberfläche abgeschnitten werden, wenn er zu lang ist.

   • Beschreibung (optional): erscheint nicht in der Onshape-Benutzeroberfläche, könnte aber bei der Authentifizierung zu sehen sein.

   • Position: wo die Erweiterung in der Onshape-Benutzeroberfläche zu finden ist.

     • Weitere Informationen finden Sie in der Entwicklerdokumentation unter Unterstützte Positionen und Kontexte.

     • Sie können nur eine Element-Registerkartenerweiterung pro Anwendung erstellen.

   • Kontext: Manche Positionen funktionieren im Kontext einer Auswahl, zum Beispiel in einem Part Studio.

     • Weitere Informationen finden Sie in der Entwicklerdokumentation unter Unterstützte Positionen und Kontexte.

   • Aktions-URL: Bei Positionen, die eine Benutzeroberfläche einbetten, definiert die Aktions-URL die Adresse der anzuzeigenden Seite. Handelt es sich bei einer Position um eine Aktion (Kontextmenü, Symbolleistenelement, Aktion im Dialogfenster usw.) und der Aktionstyp ist GET oder POST, gibt die Aktions-URL den REST-Endpunkt an. Handelt es sich bei der Position um die Aktion „In neuem Fenster öffnen“, entspricht die Aktions-URL der URL, die in dem neuen Fenster geöffnet werden soll.

     • Eine Liste der Parameter, die in diesem Feld verwendet werden können, finden Sie in der Entwicklerdokumentation unter Aktions-URL-Parameter.

   • Aktionstyp: Gilt für Standorte, die keine Benutzeroberflächen einbetten. Unterstützte Aktionstypen sind:

     • GET: löst einen GET-API-Aufruf unter Verwendung der Aktions-URL aus. Die Parameterersetzung erfolgt bei der Aktions-URL.

     • POST: löst einen POST-API-Aufruf mit der Aktions-URL und dem Aktionstext als Beitragstext. Die Parameterersetzung erfolgt sowohl für bei der Aktions-URL als auch beim Aktionstext.

     • In neuem Fenster öffnen: öffnet die Aktions-URL in einem neuen Browserfenster. Die Parameterersetzung erfolgt bei der Aktions-URL.

   • Aktionstext: gilt nur für POST-Aktionstypen. Der Aktionstext wird in einem POST-API-Aufruf übergeben und muss ein gültiges JSON-Format haben.

   • Antwort anzeigen: gilt nur, wenn der Aktionstyp GET oder POST ist. Wenn ausgewählt, wartet die Benutzeroberfläche auf eine Antwort und zeigt diese dann in einem Dialogfenster in der Benutzeroberfläche an. Die Antwort muss ein gültiges JSON-Format haben.

   • Symbol: Das Symbol wird dort angezeigt, wo die Erweiterung vorhanden ist. Das umfasst auch Symbole, die zu einer Informationspalette, einer Kontextmenü-Aktion, einer Symbolleisten-Schaltfläche, einer Aktions-Schaltfläche in einem Dialogfenster oder zu anderen unterstützten Positionen gehören.

5. Klicken Sie auf OK.

Weitere Informationen zum Erstellen und Verwalten von Onshape-Anwendungen finden Sie in der Onshape-Dokumentation für Entwickler. Ein funktionierendes Beispiel finden Sie im Tutorial Hello World.

Adminstratoren können interne Benutzer zu Anwendungen zum Testen hinzufügen, bevor sie Anwendungen an den Onshape App Store übermitteln. Benutzer, die hier hinzugefügt wurden, sehen automatisch die zugehörigen App-Erweiterungen in ihrer Onshape-Benutzeroberfläche, ohne sie die Anwendung über den App Store abonnieren zu müssen.

1. Sobald Ihre App registriert ist, klicken Sie im linken Bereich auf Anwendungen.

2. Wählen Sie die Anwendung in der Liste aus.

   

3. Beginnen Sie mit der Eingabe des Namens oder der E-Mail-Adresse eines Benutzers, Teams oder Alias in das Feld Benutzer oder Teams hinzufügen und wählen Sie ein Ergebnis aus der Liste aus. Der Administrator, der die App erstellt hat, ist automatisch in der Benutzerliste. Fügen Sie weitere Namen oder E-Mails hinzu.

   

4. Klicken Sie auf die Schaltfläche Hinzufügen.

Light-Benutzer können nicht zu Anwendungen hinzugefügt werden.

Um einen Benutzer, ein Alias oder ein Team aus der App zu entfernen, klicken Sie auf das entsprechende X-Symbol in der Spalte Entfernen.

1. Klicken Sie in Ihren Entwicklereinstellungen auf OAuth-Anwendungen.
2. Klicken Sie auf den Namen der App, die übertragen werden soll.
3. Klicken Sie auf der Registerkarte „Details“ auf die Schaltfläche Eigentümerschaft übertragen. Das Dialogfenster „Übertragen“ wird geöffnet.

   

4. Wählen Sie eine Option aus, um die App an eine Einzelperson, eine Company oder ein Enterprise zu übertragen.
5. Um an eine Einzelperson zu übertragen, geben Sie den Namen oder die E-Mail-Adresse des neuen Eigentümers in das Suchfeld ein. Um die Eigentümerschaft an eine Company oder ein Enterprise zu übertragen, wählen Sie eine Option aus dem Dropdown-Menü aus.
6. Klicken Sie auf Eigentümerschaft übertragen. Die Anwendung wird darauf aus Ihrer OAuth-Apps-Liste entfernt.
   • Wenn die App an das Konto einer Einzelperson übertragen wurde, erhält dieser Benutzer eine E-Mail-Benachrichtigung und die App wird in seinem Onshape-Entwicklerportal angezeigt.
   • Wenn die App an ein Company-, Classroom- oder Enterprise-Mitglied übertragen wurde, erhalten alle Administratoren eine E-Mail-Benachrichtigung und die App wird in ihren Entwicklereinstellungen angezeigt.

Der zukünftige Verbrauch und die Abrechnung von API-Aufrufen werden dem neuen Eigentümer zugerechnet. Weitere Informationen finden Sie unter API-Grenzwerte.

Bevor Sie eine App an den Onshape App Store einreichen, sehen Sie sich unbedingt die Anforderungen in der Onshape-Dokumentation für Entwickler an, wie korrekte Authentifizierung mit OAuth2 und das Ausfüllen der Launch-Checkliste.

Um eine vorhandene Einreichung beim Onshape App Store zu überprüfen, zu bearbeiten oder zu löschen, klicken Sie in Ihren Entwicklereinstellungen auf Store-Einreichungen und wählen dann die jeweilige Einreichung aus.

So erstellen Sie eine neue Store-Einreichung für eine OAuth-Anwendung:

1. Klicken Sie in Ihren Entwicklereinstellungen auf OAuth-Anwendungen.

2. Klicken Sie der Liste auf den Namen der App.

3. Klicken Sie auf der Detailseite der App auf Store-Einreichung erstellen.

   

4. Füllen Sie das Formular aus:

   

   • Name: wird automatisch anhand des bei der Registrierung angegebenen App-Namens festgelegt.

   • Zusammenfassung: wird automatisch anhand der bei der Registrierung bereitgestellten Zusammenfassung festgelegt.

   • Typ – Anwendungstyp: Integrierte Cloud-App, Verbundene Cloud-App oder Verbundene Desktop-App. Dies sollte dem Typ entsprechen, der bei der Registrierung der OAuth-Anwendung ausgewählt wurde.

   • Kategorie: Wählen Sie die entsprechende Kategorie für Ihre App aus.

   • Team-Sichtbarkeit: Geben Sie an, ob die private Einreichung beim App Store für keine internen Benutzer (Standard), alle internen Benutzer oder bestimmte Teams zu sehen sein soll.

   • Beschreibung: Beschreibung der Anwendung, die dem Benutzer angezeigt wird. Eine gewisse Formatierung ist möglich.

   • Support-URL: URL oder E-Mail-Adresse, an die Benutzer Ihrer App weitergeleitet werden sollten, um Hilfe zu erhalten. Diese URL oder E-Mail-Adresse muss aktiv überwacht werden.

   • Support-E-Mail: E-Mail-Adresse, an die Benachrichtigungen zum App-Abonnement gehen sollen. Diese E-Mail-Adresse muss aktiv überwacht werden.

   • Anbieter: Ihr Company-Name.

   • Version: aktuelle Version dieser Anwendung.

   • Bilder: Laden Sie optional Übersichts-, Hero- und andere Bilder hoch.

5. Klicken Sie auf Erstellen.

Die Anwendung wird im Onshape App Store als privat angezeigt. Sie ist nur für Sie und alle internen Teams sichtbar, die in den Team-Sichtbarkeitseinstellungen angegeben sind. Um die App öffentlich zu machen, sehen Sie sich als Nächstes die Launch-Checkliste an.

1. Klicken Sie im linken Bereich Ihrer Company-Einstellungen auf Entwickler.
2. Wurde Ihre App beim Onshape App Store eingereicht, löschen Sie diese Einreichung zuerst:
   1. Klicken Sie auf der Entwicklerseite auf Store-Einreichungen.
   2. Klicken Sie auf die Store-Einreichung, um sie zu löschen.
   3. Klicken auf Store-Einreichung löschenin der RegisterkarteDetails.
      
   4. Klicken Sie zur Bestätigung erneut auf Löschen.
   5. Klicken Sie im linken Bereich auf Entwickler oder auf die Breadcrumbs, um zur Entwickler-Landingpage zurückzukehren.
3. Klicken Sie in den Entwicklereinstellungen auf OAuth-Anwendungen.
4. Klicken Sie auf die Anwendung, um sie zu löschen.
5. Klicken Sie auf der Registerkarte Details auf Anwendung löschen.
   
6. Klicken Sie zur Bestätigung erneut auf Löschen.

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 werden nicht wieder auf diesen geheimen Schlüssel zugreifen können. Dieses Geheimnis gilt nur für Sie und Ihre App. Es sollte wie jedes vertrauliche Passwort geschützt und niemals in den Quellcode integriert werden.

   

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.