Connecteur OnShape

Connecteur OnShape

Intégrer Tulip à OnShape

Introduction

L'API REST d'Onshape permet aux utilisateurs d'interagir avec Onshape en ayant les bons accès à leurs comptes Onshape respectifs. Le but de ce connecteur est d'intégrer Tulip avec Onshape en utilisant des connecteurs HTTP et de fournir à nos clients un connecteur prêt à l'emploi qui peut être importé dans leur instance.

Objectif

Nous allons mettre en évidence les différentes fonctions du connecteur qui peuvent être construites en faisant des appels HTTP à l'API REST d'Onshape pour interagir avec le système Onshape afin de présenter diverses actions de lecture et d'écriture sur Onshape qui pourraient être exploitées pour divers cas d'utilisation.

Doc API

[Vue d'ensemble de l'API Onshape] (https://onshape-public.github.io/docs/apioverview/

authentification)

Pré-requis

1. Créer un compte sur Onshape et configurer les informations d'identification OAuth2.
2. Enregistrer l'API avec les scopes requis dans Onshape.

Détails de la connexion Tulip

Les informations suivantes doivent être configurées sur Tulip's

Connecteurs.

1. Exécution sur : Cloud Connector Host
2. Hôte : cad.onshape.com
3. Port : 443
4. TLS : Oui

OAuth 2 : L'authentification sera transférée à toutes les fonctions du connecteur.

fonctions du connecteur

Fonctions du connecteur

Obtenir tous les documents

Objectif

Ce connecteur récupère tous les documents dans l'espace de travail Onshape d'un utilisateur.

Point d'arrivée

Appel HTTP GET au point de terminaison : https://cad.onshape.com:443/api/documents

Données requises

Aucune entrée requise

Sortie requise Extracteur

1. Document ID : Identifiant unique du document qui sera utilisé pour effectuer les autres tâches.
2. Nom du document : Nom d'affichage du document.
3. ID de l'espace de travail : Identifiant unique de l'espace de travail du document qui sera utilisé pour effectuer les autres tâches.
4. Les paramètres supplémentaires renvoyés avec la réponse sont inclus dans les paramètres de sortie.

Obtenir tous les éléments d'un document spécifique

Objectif

Ce connecteur permet de récupérer tous les éléments d'un document spécifique en transmettant les données d'entrée requises.

Point d'arrivée

Appel HTTP GET au point de terminaison : https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elements

Données requises

Les paramètres URL à transmettre sont les suivants

1. ID du document
2. ID de l'espace de travail

Sortie requise Extracteur

1. ID de l'élément : Identifiant unique de l'élément qui sera utilisé pour effectuer les autres tâches.
2. Nom de l'élément : Nom d'affichage de l'élément.
3. Type d'élément : Le type de l'élément.
4. Les paramètres supplémentaires renvoyés avec la réponse sont inclus dans les paramètres de sortie.

Obtenir les propriétés de l'élément

Objectif

Ce connecteur permet de récupérer toutes les propriétés d'un type d'élément spécifique faisant partie d'un document.

Point d'arrivée

Appel HTTP GET au point de terminaison : https://cad.onshape.com:443/api/documents/d/{DocumentID}/w/{WorkspaceID}/elements?elementType={ElementType}&elementId={ElementID}

Données requises

Les paramètres URL à transmettre sont les suivants

1. ID du document
2. ID de l'espace de travail
3. ID de l'élément
4. Type d'élément

Extracteur de sortie requis

1. ID de l'élément : Identifiant unique de l'élément qui sera utilisé pour effectuer les autres tâches.
2. Nom de l'élément : Nom d'affichage de l'élément.
3. Type d'élément : Le type de l'élément.
4. Les paramètres supplémentaires renvoyés avec la réponse sont inclus dans les paramètres de sortie.

Obtenir les détails du corps du studio de la pièce

Objectif

Ce connecteur permet d'obtenir tous les détails du corps d'un élément Part Studio d'un document spécifique en transmettant les données d'entrée requises.

Point d'arrivée

Appel HTTP GET au point de terminaison : https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/bodydetails

Données requises

Les paramètres URL à transmettre sont les suivants

1. ID du document
2. ID de l'espace de travail
3. ID de l'élément

Extracteur de sortie requis

1. Body ID : Identifiant unique de l'organisme qui sera utilisé pour effectuer les autres tâches.
2. Type d'organe : Le type de corps de la partie.
3. Les paramètres supplémentaires renvoyés avec la réponse sont inclus dans les paramètres de sortie.

Obtenir les boîtes de délimitation du studio de la pièce

Objectif

Ce connecteur permet de récupérer toutes les boîtes de délimitation d'un élément Part Studio d'un document spécifique en transmettant les données d'entrée requises.

Point d'arrivée

Appel HTTP GET au point de terminaison : https://cad.onshape.com:443/api/partstudios/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes

Données requises

Les paramètres URL à transmettre sont les suivants

1. ID du document
2. ID de l'espace de travail
3. ID de l'élément

Sortie requise Extracteur

1. Low X : Valeur de lowX.
2. Low Y : Valeur de lowY.
3. Low Z : Valeur de lowZ.
4. High X : Valeur de highX.
5. High Y : Valeur de highY.
6. High Z : Valeur de highZ.

Obtenir les métadonnées d'une pièce individuelle

Objectif

Ce connecteur permet de récupérer les métadonnées d'une partie individuelle d'un élément Part Studio d'un document spécifique en transmettant les données d'entrée requises.

Point d'arrivée

Appel HTTP GET au point de terminaison : https://cad.onshape.com:443/api/metadata/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/p/{PartID}

Données requises

Les paramètres URL à transmettre sont les suivants

1. ID du document
2. ID de l'espace de travail
3. ID de l'élément
4. ID de la partie

Extracteur de sortie requis

1. Part ID : Identifiant unique de la partie qui sera utilisée pour exécuter les autres tâches.
2. Type de pièce : Le type de partie.
3. Les paramètres supplémentaires renvoyés avec la réponse sont inclus dans les paramètres de sortie.

Obtenir la définition de l'assemblage

Objectif

Ce connecteur permet d'obtenir la définition de l'assemblage d'un élément d'assemblage d'un document spécifique en transmettant les données d'entrée requises.

Point d'arrivée

Appel HTTP GET au point de terminaison : https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}

Données requises

Les paramètres URL à transmettre sont les suivants

1. ID du document
2. ID de l'espace de travail
3. ID de l'élément

Extracteur de sortie requis

1. ID de l'instance : identifiant unique de l'instance qui sera utilisée pour effectuer les autres tâches.
2. Nom de l'instance : Nom de l'instance.
3. Les paramètres supplémentaires renvoyés avec la réponse sont inclus dans les paramètres de sortie.

Obtenir les limites d'un assemblage

Objectif

Ce connecteur permet de récupérer toutes les boîtes englobantes d'un élément Assembly d'un document spécifique en transmettant les données d'entrée requises.

Point d'arrivée

Appel HTTP GET au point de terminaison : https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/boundingboxes

Données requises

Les paramètres URL à transmettre sont les suivants

1. ID du document
2. ID de l'espace de travail
3. ID de l'élément

Sortie requise Extracteur

1. Low X : Valeur de lowX.
2. Low Y : Valeur de lowY.
3. Low Z : Valeur de lowZ.
4. High X : Valeur de highX.
5. High Y : Valeur de highY.
6. High Z : Valeur de highZ.

Obtenir la nomenclature de l'assemblage

Objectif

Ce connecteur permet d'obtenir la nomenclature d'un élément d'assemblage d'un document spécifique en transmettant les données d'entrée requises.

Point d'arrivée

Appel HTTP GET au point de terminaison https://cad.onshape.com:443/api/assemblies/d/{DocumentID}/w/{WorkspaceID}/e/{ElementID}/bom

Données requises

Les paramètres URL à transmettre sont les suivants

1. ID du document
2. ID de l'espace de travail
3. ID de l'élément

Extracteur de sortie requis

1. Bill Material ID : Identifiant unique de la table de nomenclature.
2. Nom de la nomenclature : Nom de la table de nomenclature.
3. Type de nomenclature : Type de table de nomenclature.
4. Les paramètres supplémentaires renvoyés avec la réponse sont inclus dans les paramètres de sortie.