/onshape_oauthexample

Onshape Example Client using PHP

Primary LanguageTypeScriptBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

onshape_oauthexample

Onshape Example Client using PHP

This example shows how to create an Onshape client with a PHP backend (basically no significant server) and OAuth authentication. All of the backend support is handled by simple PHP LAMHDAs. To use this you need to

Initial setup

  1. Clone/fork the repository to your own machine to edit

  2. Identify a server where the minimal backend components will be hosted. For purposes of this example, we shall assume that they are at https://ftconshape.com/oauthexample/

  3. Create an Onshape OAuth application at https://dev-portal.onshape.com/oauthApps. When you create the App, remember the Secret (which you can only see once) and the client id.

  4. In the settings, set the redirect URL to be the URL from step 2. Also, make sure you select an Admin team who has access to the applicaiton.

  5. Copy example_config.php as config.php and update the client id and client secret.

  6. For the settings in the Redirect URLs, point it to the location of the backend components (in this case https://ftconshape.com/oauthexample/)

  7. Create an extension entry (we are using an Element Right Panel here) and for the action URL, enter the following. Note that you need to replace <clientid> with the client id you got in step 3 and the <backenduri> from step 2 but with the URL encoded (you can use https://www.urlencoder.org/ to encode the URL). While you are there, don't forget to update the icon with a .svg file.

    https://oauth.onshape.com/oauth/authorize?response_type=code&client_id=<clientid>%3D&redirect_uri=<backenduri>%3FdocumentId%3D{$documentId}%26workspaceId%3D{$workspaceOrVersionId}%26elementId%3D{$elementId}

  8. Change the line in app/app.ts for myserver to be the server from step 1 (but leave off the trailing /)

     public myserver = 'https://ftconshape.com/oauthexample';

  9. Edit the example_ftpdeploy.js file and save it as .ftpdeploy.js putting in your credentials for FTPing files to the server

  10. Do a npm run build to ensure everything builds properly

Normal Development

  1. Once you are happy, you can do an npm run deploy to automatically copy all of the files to your server.
  2. As a convenince you can also do npm run deploy-dev to build and deploy the development version of the code or npm run deploy-prod to deploy the production (mininized) version.

If you have done everything right, when you add the application to your account, you should see an icon appear on the right hand edge of the screen (along with the configuration and appearance icons). When you click on it, it may promopt you for permissions and then once it has been granted will show a dump of all the files you have shared with you.

To make change so the application, edit the app/app.ts file. It is built on top of the app/baseapp.ts file which has all the common routines.

Calling Onshape APIs

All of the Onshape APIs are available via this.onshape. Onshape has a REST API EXPLORER explorer that you can view all of the calls and search them. All of the APIs are made available as Typescript interfaces at through onshape-typescript-fetch. You can find documentation here.