The Acquia DAM Typescript Software Development Kit (SDK) enables developers to efficiently create scripts, programs, and integrations. It provides Type information and documentation directly in the developer’s code editor. This setup enhances the coding experience and reduces the need for individual testing and debugging of each call. The SDK is available on npmjs.com and is installed through any Javascript or Typescript package manager.
Are there any language-specific tools to help me use the API?
Yes, the Acquia DAM SDK is a language-specific tool designed to facilitate the use of the API. It enables developers to efficiently create scripts, programs, and integrations by providing Type information and documentation directly in the developer’s code editor. This tool enhances the coding experience and reduces the need for individual testing and debugging of each call. For detailed information, visit Developing for Acquia DAM using the Acquia DAM Typescript SDK.
Where can I get updates about the API and test changes? Can I subscribe?
To keep your technical staff in the loop about updates to our app, our developers have created a blog with posts that highlight details about specific API changes. So you can test and prepare for upcoming changes, information about early access toggles is also included in posts. We recommend that you and your technical staff subscribe to the blog to stay on top of the latest and greatest updates to our API.
Where can I get an API access token?
You can get access tokens for the API from Admin app of Acquia DAM > API Setup under Global Settings in the left navigation.
What are refresh tokens, and how do they work with integrations?
When an integrated app (for example, Adobe or WordPress) makes a call to Acquia DAM through the API, this call must be accompanied by an access token that gives the integrated app access to a user’s DAM account. Refresh tokens can be used to automatically generate additional access tokens for users. For added security, the access tokens generated by refresh tokens expire after eight hours. A refresh token can only be used once, and a new refresh token is issued during an exchange. If a refresh token is not used, it will expire after six months. For more information, see the DAM developer blog.
To enable refresh tokens for a new integration with the DAM V2 API, submit a support case. The DAM Customer Support team will create a new integration with refresh tokens enabled.
How are API calls permissioned?
Every API call must be accompanied by a bearer token in the authorization header (the access token). These tokens are associated with a specific account in the DAM. We recommend creating a non-user account (e.g., [email protected]) for setting up integrations and generating bearer tokens to prevent an integration from becoming disabled if the person who creates it leaves your organization.
The assets you will have access to via the API are determined by the roles and permissions of your DAM account.
How do I query for assets that have recently changed?
To return all assets that have been edited since a specific date (e.g., July 1, 2016), use this quick search:
lastEditDate:[after 07/01/2016]
To return all assets that have been edited since a specific time (e.g., July 1, 2017, at midnight, CT), use this quick search:
lastEditDate:[after 2017-07-01T05:00:00Z]
To return all assets that have been uploaded between two times (e.g., from July 1, 2017, at midnight, CT, to July 1, 2017, at 1:00 a.m., CT), use this quick search:
DateAdded:[2017-07-01T05:00:00Z to 2017-07-01T06:00:00Z]
All timestamps must be represented as ISO8601 format in GMT time.
To get all assets that have been edited within the past week (seven days), use this quick search:
lastEditDate:[within -7]
If you want to see all assets that have been uploaded into the DAM in the past two days, use this quick search:
DateAdded:[within -2]
These quick search strings can then be URL encoded and passed into the Asset Search endpoint as a query parameter.
Can I search by upload or last edit time as well as date?
No. Date searches within both the API and the DAM are granular to the day, not to a specific timestamp.
Does the API cache responses?
No. Every API query will make a new call to either the elastic search index or directly to the database as needed.
Is there a limit to the number of API calls that can be made at one time?
Yes. A rate limit of 50 calls per second to the API is enforced. Exceeding this rate results in an HTTP 429 Too Many Requests error response. Uploads are included in the rate limit, and chunked uploads are further limited to only 40 concurrent uploads.
This rate limit only applies to calls directly to the API (version 1.0 and 2.0). Calls to download links that use our high availability content delivery network (embed.widencdn.net) are not subject to any limits, even if those links are served through the API.
If your integration is regularly hitting the limit of 50 requests per second, you could try one of these techniques:
When applicable, implement API response caching within your integration.
Inspect and make use of the X-RateLimit headers included on all API responses. These headers will provide detailed information about the current rate limit state, which can be used to better stay within the limits. For more details, read our developer blog post about API rate limits.
Is there a limit to the number of API calls that can be made per month?
No, but pricing varies. Customers making more than 500,000 API calls per month will need to pay for overages or upgrade their package to get one million or unlimited calls.
API call counts start over at the beginning of each month. Those with the Entries app can make an additional 500,000 calls per month with no added charge.
This does not apply to those who became DAM customers before April 1, 2022.
Are some integrations and connectors excluded from API usage tracking?
Yes, these integrations and connectors are excluded:
Acquia DAM module
All native integrations
CI HUB integrations
Drupal Cloud integration
Highspot
Optimizely
Acquia DAM Hootsuite connector
Acquia DAM WordPress plug-in
Zapier
How do I disable an API token?
There are four ways you can disable an API token in the DAM.
Delete the user account that created the token. Permissions for an API token come from the user account it was generated against, so deleting or expiring that user account invalidates all permissions.
Disable the integration through which the token was created. Go to the Admin app, then click Global Settings and API Setup. Note that this will invalidate all tokens that were created through that integration.
Yes! With webhooks, your integrated systems can receive notifications from DAM through the API when DAM assets are created, deleted, or updated. Learn more about webhooks in the Developer Portal.
API FAQs
What is the Acquia DAM TypeScript SDK?
The Acquia DAM Typescript Software Development Kit (SDK) enables developers to efficiently create scripts, programs, and integrations. It provides Type information and documentation directly in the developer’s code editor. This setup enhances the coding experience and reduces the need for individual testing and debugging of each call. The SDK is available on npmjs.com and is installed through any Javascript or Typescript package manager.
Are there any language-specific tools to help me use the API?
Yes, the Acquia DAM SDK is a language-specific tool designed to facilitate the use of the API. It enables developers to efficiently create scripts, programs, and integrations by providing Type information and documentation directly in the developer’s code editor. This tool enhances the coding experience and reduces the need for individual testing and debugging of each call. For detailed information, visit Developing for Acquia DAM using the Acquia DAM Typescript SDK.
Where can I get updates about the API and test changes? Can I subscribe?
To keep your technical staff in the loop about updates to our app, our developers have created a blog with posts that highlight details about specific API changes. So you can test and prepare for upcoming changes, information about early access toggles is also included in posts. We recommend that you and your technical staff subscribe to the blog to stay on top of the latest and greatest updates to our API.
Where can I get an API access token?
You can get access tokens for the API from Admin app of Acquia DAM > API Setup under Global Settings in the left navigation.
What are refresh tokens, and how do they work with integrations?
When an integrated app (for example, Adobe or WordPress) makes a call to Acquia DAM through the API, this call must be accompanied by an access token that gives the integrated app access to a user’s DAM account. Refresh tokens can be used to automatically generate additional access tokens for users. For added security, the access tokens generated by refresh tokens expire after eight hours. A refresh token can only be used once, and a new refresh token is issued during an exchange. If a refresh token is not used, it will expire after six months. For more information, see the DAM developer blog.
To enable refresh tokens for a new integration with the DAM V2 API, submit a support case. The DAM Customer Support team will create a new integration with refresh tokens enabled.
How are API calls permissioned?
Every API call must be accompanied by a bearer token in the authorization header (the access token). These tokens are associated with a specific account in the DAM. We recommend creating a non-user account (e.g., [email protected]) for setting up integrations and generating bearer tokens to prevent an integration from becoming disabled if the person who creates it leaves your organization.
The assets you will have access to via the API are determined by the roles and permissions of your DAM account.
How do I query for assets that have recently changed?
To return all assets that have been edited since a specific date (e.g., July 1, 2016), use this quick search:
lastEditDate:[after 07/01/2016]
To return all assets that have been edited since a specific time (e.g., July 1, 2017, at midnight, CT), use this quick search:
lastEditDate:[after 2017-07-01T05:00:00Z]
To return all assets that have been uploaded between two times (e.g., from July 1, 2017, at midnight, CT, to July 1, 2017, at 1:00 a.m., CT), use this quick search:
DateAdded:[2017-07-01T05:00:00Z to 2017-07-01T06:00:00Z]
All timestamps must be represented as ISO8601 format in GMT time.
To get all assets that have been edited within the past week (seven days), use this quick search:
lastEditDate:[within -7]
If you want to see all assets that have been uploaded into the DAM in the past two days, use this quick search:
DateAdded:[within -2]
These quick search strings can then be URL encoded and passed into the Asset Search endpoint as a query parameter.
Can I search by upload or last edit time as well as date?
No. Date searches within both the API and the DAM are granular to the day, not to a specific timestamp.
Does the API cache responses?
No. Every API query will make a new call to either the elastic search index or directly to the database as needed.
Is there a limit to the number of API calls that can be made at one time?
Yes. A rate limit of 50 calls per second to the API is enforced. Exceeding this rate results in an HTTP 429 Too Many Requests error response. Uploads are included in the rate limit, and chunked uploads are further limited to only 40 concurrent uploads.
This rate limit only applies to calls directly to the API (version 1.0 and 2.0). Calls to download links that use our high availability content delivery network (embed.widencdn.net) are not subject to any limits, even if those links are served through the API.
If your integration is regularly hitting the limit of 50 requests per second, you could try one of these techniques:
When applicable, implement API response caching within your integration.
Inspect and make use of the X-RateLimit headers included on all API responses. These headers will provide detailed information about the current rate limit state, which can be used to better stay within the limits. For more details, read our developer blog post about API rate limits.
Is there a limit to the number of API calls that can be made per month?
No, but pricing varies. Customers making more than 500,000 API calls per month will need to pay for overages or upgrade their package to get one million or unlimited calls.
API call counts start over at the beginning of each month. Those with the Entries app can make an additional 500,000 calls per month with no added charge.
This does not apply to those who became DAM customers before April 1, 2022.
Are some integrations and connectors excluded from API usage tracking?
Yes, these integrations and connectors are excluded:
Acquia DAM module
All native integrations
CI HUB integrations
Drupal Cloud integration
Highspot
Optimizely
Acquia DAM Hootsuite connector
Acquia DAM WordPress plug-in
Zapier
How do I disable an API token?
There are four ways you can disable an API token in the DAM.
Delete the user account that created the token. Permissions for an API token come from the user account it was generated against, so deleting or expiring that user account invalidates all permissions.
Disable the integration through which the token was created. Go to the Admin app, then click Global Settings and API Setup. Note that this will invalidate all tokens that were created through that integration.
Yes! With webhooks, your integrated systems can receive notifications from DAM through the API when DAM assets are created, deleted, or updated. Learn more about webhooks in the Developer Portal.
Did not find what you were looking for?
If this content did not answer your questions, try searching or contacting our support team for further assistance.
Did not find what you were looking for?
If this content did not answer your questions, try searching or contacting our support team for further assistance.
Acquia DAM (Widen)