https://github.com/yiskang/aps-pkce-auth-autocad-dotnet-addin

https://github.com/yiskang/aps-pkce-auth-autocad-dotnet-addin

Last synced: 21 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/yiskang/aps-pkce-auth-autocad-dotnet-addin
• Owner: yiskang
• License: mit
• Created: 2024-02-02T07:59:18.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-02-02T08:21:54.000Z (11 months ago)
• Last Synced: 2024-10-31T02:52:08.205Z (2 months ago)
• Language: C#
• Size: 10.7 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# APS PKCE AUTH AUTOCAD DOTNET ADDIN

![Platforms](https://img.shields.io/badge/platform-Windows|MacOS-lightgray.svg)

![.NET](https://img.shields.io/badge/.NET%20Core-3.1-blue.svg)

[![License](http://img.shields.io/:license-MIT-blue.svg)](http://opensource.org/licenses/MIT)

[![oAuth2](https://img.shields.io/badge/oAuth2-v1-green.svg)](http://developer.autodesk.com/)

## Introduction

This sample demonstrates a quick workflow to generate a three legged token from a AutoCAD 2024 .NET Addin using [3-Legged Token with Authorization Code Grant (PKCE)](https://aps.autodesk.com/en/docs/oauth/v2/tutorials/get-3-legged-token-pkce/)

## How it works

1 – Type `NETLOAD` command to load the DLL of this sample

2 – User access the AutoCAD addin command by typing `GetApsThreeLeggedToken` in AutoCAD Console

3 – App redirects the user to APS authorization server

4 – After logging in and allowing access, authorization server sends credential code to call-back url and this request is intercepted by the AutoCAD addin command.

5 – AutoCAD addin command sends credential code with code verifier to Exchange it for a token

6 – Oauth API returns the token (including refresh token) to AutoCAD

7 – The AutoCAD addin command opens a `TaskDialog` to show obtained access token

# Setup

## Prerequisites

1. **APS Account**: Learn how to create a APS Account, activate subscription and create an app at [this tutorial](http://aps.autodesk.com/tutorials/#/account/).

2. **Visual Studio**: Community or Pro.

3. **.NET** basic knowledge with C#

## Running locally

Clone this project or download it. It's recommended to install [GitHub desktop](https://desktop.github.com/). To clone it via command line, use the following (**Terminal** on MacOSX/Linux, **Git Shell** on Windows):

    git clone https://github.com/yiskang/aps-pkce-auth-autocad-dotnet-addin

**Visual Studio** (Windows):

Go to ApsAuthACAD folder, change **client id** and **callback url** with your own in `Command.cs`, and then build the solution in Visual Studio. 

Type `NETLOAD` command to load the complied DLL.

# Further Reading

### Troubleshooting

1. **Not being redirected**: Make sure to add your callback url to your aps app.

2. **Not retrieving the token**: Make sure you've provided the proper callback to httplistener 

3. **Not able to read ACC/BIM 360 data with acquired token**: Make sure to provision the APS App Client ID within the BIM 360 Account, [learn more here](https://aps.autodesk.com/blog/bim-360-docs-provisioning-forge-apps). This requires the Account Admin permission.

## License

This sample is licensed under the terms of the [MIT License](http://opensource.org/licenses/MIT). Please see the [LICENSE](LICENSE) file for full details.

## Written by

Eason Kang [@yiskang](https://twitter.com/yiskang), [Developer Advocacy and Support](http://aps.autodesk.com)