Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.
Extra information
System documentation: Onshape API Reference
Setting up HTTP Client Onshape
Steps
-
In Alumio Dashboard, go to Connections → HTTPS (API). Create a new HTTP Client and select Onshape HTTP Client as the prototype of the HTTP Client.
-
Fill in the Base URI, Api Key, and Secret Key.
Subscribing to Entities from Onshape
Steps
-
Go to Integrations → Incoming and create a new Incoming configuration and select Onshape Subscriber as the subscriber.
-
Select the entity you want to subscribe to from Onshape.
-
Add any request parameters needed to subscribe to the entity (optional).
-
You can optionally add a transformer to transform the request parameters into something you need.
-
Select the Onshape HTTP Client to use.
General Concept
We follow Onshape documentation for building this connector, so you can easily use it based on the Onshape API Reference.
Entity
It’s the entity you want to subscribe to from Onshape. Please refer to the entities in the Management APIs from the Onshape API Reference page.
Request Parameters
These are the parameters you can provide to get the needed entity based on the Onshape API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing Single Request entity
- Path is the path parameter of the URL. For example, the {cid}.
- Query is a defined set of parameters attached to the end of a URL.
Example: URL.com - MediaOptions
That’s why we need to define cid property inside path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on the get company information entity.
/companies/123456
Input Transformer
Any transformer set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need, either as path parameters and/or as query parameters of an entity.
HTTP Client
It’s the HTTP Client configuration or prototype you will use to access Onshape.
Publishing Entity to Onshape
Steps
- Go to Integrations → Outgoing, create a new Outgoing configuration, and select Onshape Publisher as the publisher.
- Select the method that you want the publisher to use with the data.
- Select the Onshape entity you want the data to be published to.
- Select the HTTP Client to use.
General Concept
Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in the outgoing configuration).
Method
Currently, we support Post (HTTP POST method), and Delete (HTTP DELETE method).
Entity
We support publishing to most Onshape endpoints, but not with publishing binary files at the moment. Please refer to the entities in the Management APIs from the Onshape API Reference page. Based on the documentation, some endpoints may need one or more path parameters.
For endpoints that require an object as the request payload, please look at the example below. For example, we want to create a new publication. Please select “Post” as the action and “Create a new publication” as the entity of the publisher.
You can put the payload you want to send to Onshape into the payload property in the data (go to Advanced).
- Path is the path parameter of the URL. For example, the {id}.
- Query is a defined set of parameters attached to the end of a URL.
Example: URL.com - MediaOptions - Payload is the data contained within a request.
Alumio will send an API request to Onshape with URL /publications
HTTP Client
It’s the HTTP Client configuration or prototype you will use to access Onshape.