The Acquia DAM Typescript Software Development Kit (SDK) is an open source extension of the Acquia DAM API. It streamlines the development process by enabling developers to create scripts, programs, and integrations efficiently. The SDK uses the following features to enhance developer experience:
- Type safety features of Typescript
- Autocomplete, suggestions, and tooltips features of code editors
Typescript, as a superset of Javascript, allows the SDK to be used in Javascript-only applications without modifications.
Use cases
The Acquia DAM Typescript SDK can be used to:
- Build custom integrations with software tools not yet supported by Native and Partner integrations.
- Integrate with home-grown or on-premises software solutions.
- Create applications that display assets or entries uniquely.
- Develop one-off or repeatable bulk-update scripts.
- Design dashboards that display analytics or other data served by DAM.
Differences from the API
The Acquia DAM API defines interaction with DAM through HTTP. The SDK acts as a language-specific tool that employs the API internally. It provides Type information and documentation directly in the developer’s code editor to ensure correct input names and types during development. This approach reduces the need for individual testing and debugging of each call, and helps developers to focus on program features rather than the format of HTTP requests.
Installation
The SDK is available on npmjs.com and is installed through any Javascript or Typescript package manager. For detailed installation instructions, visit the README file.
Eligibility
- Customers: Acquia DAM customers can use the SDK. Note that operations performed using the SDK count towards your API usage.
- Partners: Partners must contact Acquia DAM Support to set up the test account access.
Open source
The SDK source code is open for anyone to use, copy, or modify. Developers report issues and suggest improvements, which go through a rigorous review process before incorporation. New releases follow semantic versioning to ensure compatibility.
For more details on contributing, visit the project GitHub repository.
Additional Resources
Developing for Acquia DAM using the Acquia DAM Typescript SDK
The Acquia DAM Typescript Software Development Kit (SDK) is an open source extension of the Acquia DAM API. It streamlines the development process by enabling developers to create scripts, programs, and integrations efficiently. The SDK uses the following features to enhance developer experience:
- Type safety features of Typescript
- Autocomplete, suggestions, and tooltips features of code editors
Typescript, as a superset of Javascript, allows the SDK to be used in Javascript-only applications without modifications.
Use cases
The Acquia DAM Typescript SDK can be used to:
- Build custom integrations with software tools not yet supported by Native and Partner integrations.
- Integrate with home-grown or on-premises software solutions.
- Create applications that display assets or entries uniquely.
- Develop one-off or repeatable bulk-update scripts.
- Design dashboards that display analytics or other data served by DAM.
Differences from the API
The Acquia DAM API defines interaction with DAM through HTTP. The SDK acts as a language-specific tool that employs the API internally. It provides Type information and documentation directly in the developer’s code editor to ensure correct input names and types during development. This approach reduces the need for individual testing and debugging of each call, and helps developers to focus on program features rather than the format of HTTP requests.
Installation
The SDK is available on npmjs.com and is installed through any Javascript or Typescript package manager. For detailed installation instructions, visit the README file.
Eligibility
- Customers: Acquia DAM customers can use the SDK. Note that operations performed using the SDK count towards your API usage.
- Partners: Partners must contact Acquia DAM Support to set up the test account access.
Open source
The SDK source code is open for anyone to use, copy, or modify. Developers report issues and suggest improvements, which go through a rigorous review process before incorporation. New releases follow semantic versioning to ensure compatibility.
For more details on contributing, visit the project GitHub repository.
Additional Resources
Acquia DAM