Share

Custom Integrations

Custom integrations are the integration that you develop using publicly available Autodesk APIs to expand the capabilities of your platform. Sign up at Autodesk Platform Services. You can also find the API documentation there.

Custom integrations can have their permissions controlled by Secure Service Accounts (SSAs). Learn more about SSAs in Secure Service Accounts.

Add Custom Integrations

To add a custom integration, you must first create a custom integration in the Autodesk Platform Services (APS) portal. After you create the custom integration, you can add it to the Autodesk Construction Cloud platform (ACC).

Note: You must have an ACC account to add a custom integration.
  1. Click Add custom integration in the Custom integrations tool.
  2. Provide your APS Client ID. The Client ID is the unique identifier for your custom integration. You can find the Client ID in the APS portal.
  3. Provide your integration name.
  4. Provide an integration description.
  5. Click Next.

Add custom integration

  1. Previously configured Secure Service Accounts (SSAs) for your Client ID will automatically be retrieved.
    • If no SSAs are found, there will be no way to control the permissions for this integration and it will act as an Account Administrator with immediate access to all data within your account. Click Proceed anyway to complete the integration.
    • If a single SSA is detected, the integration is automatically attached to this SSA. No data access is granted to the integration until the SSA account has been invited to a project. Click Got it to complete the integration.
    • If multiple SSAs are detected, provide the email address of the SSA you wish to attach to this integration. Click Add to complete the integration.

Integration Status

The integration status indicates whether the integration is active or inactive. You can change the integration status at any time. To troubleshoot issues with your integration, it is recommended that you set the integration status to inactive.

  • Active: The integration can read and write data to the Autodesk Construction Cloud (ACC) platform using Autodesk APIs.
  • Inactive: The integration is not reading or writing data to the ACC platform using Autodesk APIs.

To change the status of an integration:

  1. Select the integration from the integration list in the Custom integrations tool.
  2. Select the status drop-down list and choose the desired status.

Integration Access

Selecting a custom integration from the list in the Custom integrations tool will show details about the integration, including its access level. The highest level of access that the integration has across all projects is shown here. For example, if the integration has full access to one of your projects, but restricted access to another project, the integration access will still be "Full Project Access".

To view details on the access level of an integration on a per project basis:

  1. Select the integration from the integration list in the Custom integrations tool.
  2. Under "Integration access", Click the number of projects link.

Integration access

There are three possible access levels, each meaning the following:

  • Full Account Access: No associated SSA, so the integration has Account Administrator access to all data in your account. Since no SSA exists, the integration will use two-legged authentication.
  • Full Project Access: The SSA attached to the integration is a Project Administrator to at least one project.
  • Project Access: The SSA attached to the integration is a Project Member to all projects it has been invited to.
Note: To attach an SSA to an integration which previously did not have one, delete and re-create the integration after having created an SSA by following the Secure Service Account API documentation.

To modify the access of an existing SSA, go to the Members tool of Project Admin within each project.

Delete Integration

You can delete an integration that is no longer useful. The Inactive status should be used to temporarily stop an integration from transferring data to and from ACC. Deleting the integration removes it from the list, but it can be added again. To delete an integration:

  1. Select the integration from the integration list in the Custom integrations tool.
  2. Click the More menu more menu in the drawer.
  3. Select Delete integration.
  4. Click Remove in the confirmation dialog.

Was this information helpful?