API Basics
The Autodesk Platform Service (APS) allows applications to access Autodesk web services with APIs only if applications are registered with APS. When you register an application, APS assigns that application a Client ID and a Client Secret. These credentials uniquely identify the application and authorize its API calls. You can manage application registration and access through the applications page on the APS Developer Portal. The Application Management API lets you perform some of these tasks programmatically.
The following terms are used throughout the documentation:
| Term | Description |
|---|---|
| Client | Application that can access APS on behalf of the end-user |
| Client Secret | String used to authenticate the identity of the client app |
| Collaborator | User who has access to an APS app. A collaborator can be a viewer or editor |
Authentication
Application Management API requires using the standard APS Authentication service to authenticate your requests. Depending on the operation, you must either obtain a 3-legged token or obtain a 2-legged token. The 3-legged token is used to access the API on behalf of the end-user, while the 2-legged token is used to access the API on behalf of the application itself.
For Application Management API, we use the following unique scopes:
application:client:read: Read-only access to the app’s informationapplication:client:write: Create and update appsapplication:client:rotate_secret: Rotate an app’s client secret
HTTP GET requests for the collaborator and client operations will use the application:client:read scope and three-legged OAuth token.
HTTP POST requests for client secret rotation operations will use the application:rotate_secret scope and two-legged OAuth token.
