README.md

Data Exchange Explorer

Simple explorer of Autodesk Platform Services Data Exchanges and their graphs.

Development

Prerequisites

• APS credentials (see the Create an App tutorial)
• Access to an Autodesk Construction Cloud project (currently the Data Exchanges are only supported in this product)
• Node.js (we recommend the LTS version), and yarn
• Terminal (for example, Windows Command Prompt, or macOS Terminal)

Setup & Run

• Clone this repository
• Install dependencies: yarn install
• Setup env. variables:
  • APS_CLIENT_ID - your APS application client ID
  • APS_CLIENT_SECRET - your APS application client secret
  • APS_CALLBACK_URL - callback URL for the login workflow
    • When running locally, this should be http://localhost:8080/api/auth/callback
    • Also, make sure that you setup the exact same callback URL for your APS app in https://aps.autodesk.com/myapps
  • SERVER_SESSION_SECRET - arbitrary string that will be used to encipher/decipher session cookies
  • USE_CACHE (optional) - when set to a non-empty string, the app will cache all Data Exchange responses, and respond with the cached data next time it is requested
• Run the app: npm start

If you're using Visual Studio Code, consider creating a .vscode/launch.json with the following content (replacing the placeholders with your actual env. var. values):

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "pwa-node",
            "request": "launch",
            "name": "Launch Program",
            "skipFiles": [
                "<node_internals>/**"
            ],
            "program": "${workspaceFolder}/server.js",
            "env": {
                "APS_CLIENT_ID": "your-client-id",
                "APS_CLIENT_SECRET": "your-client-secret",
                "APS_CALLBACK_URL": "http://localhost:8080/api/auth/callback",
                "SERVER_SESSION_SECRET": "your-secret-phrase",
                "USE_CACHE": "true"
            }
        }
    ]
}

Then you can easily run and debug the application right from the editor.

Troubleshooting

Submit your question via APS Support Form.

License

This sample is licensed under the terms of the MIT License. Please see the LICENSE file for more details.

Author

Petr Broz, Developer Advocate