The Agravity GlobalDAM API which allowes API key authenticated access the Agravity GlobalDAM Backend
npm install @agravity/publicThe Agravity Public API provides comprehensive access to digital asset management functionality for technical integrations, portals, and third-party applications. These endpoints are designed for programmatic access with API key authentication.
All endpoints (except public share endpoints) require API key authentication. The API key can be provided:
Portal endpoints may have additional authentication methods (OAuth, Azure AD, Auth0, password) depending on portal configuration.
For technical support or integration questions, contact support@agravity.io or visit https://agravity.io.
Copyright © Agravity GmbH 2026. All Rights Reserved
The version of the OpenAPI document: 10.2.5
To install the required dependencies and to build the typescript sources run:
``console`
npm install
npm run build
First build the package then run npm publish dist (don't forget to specify the dist folder!)
Navigate to the folder of your consuming project and run one of next commands.
_published:_
`console`
npm install @agravity/public@10.2.5 --save
_without publishing (not recommended):_
`console`
npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
_using npm link:_
In PATH_TO_GENERATED_PACKAGE/dist:
`console`
npm link
In your project:
`console`
npm link @agravity/public
__Note for Windows users:__ The Angular CLI has troubles to use linked npm packages.
Please refer to this issue
Published packages are not effected by this issue.
In your Angular project:
`typescript
import { ApplicationConfig } from '@angular/core';
import { provideHttpClient } from '@angular/common/http';
import { provideApi } from '@agravity/public';
export const appConfig: ApplicationConfig = {
providers: [
// ...
provideHttpClient(),
provideApi()
],
};
`
NOTE
If you're still using AppModule and haven't migrated yet, you can still import an Angular module:`typescript`
import { AgravityPublicApiModule } from '@agravity/public';
If different from the generated base path, during app bootstrap, you can provide the base path to your service.
`typescript
import { ApplicationConfig } from '@angular/core';
import { provideHttpClient } from '@angular/common/http';
import { provideApi } from '@agravity/public';
export const appConfig: ApplicationConfig = {
providers: [
// ...
provideHttpClient(),
provideApi('http://localhost:9999')
],
};
`
`typescript
// with a custom configuration
import { ApplicationConfig } from '@angular/core';
import { provideHttpClient } from '@angular/common/http';
import { provideApi } from '@agravity/public';
export const appConfig: ApplicationConfig = {
providers: [
// ...
provideHttpClient(),
provideApi({
withCredentials: true,
username: 'user',
password: 'password'
})
],
};
`
`typescript
// with factory building a custom configuration
import { ApplicationConfig } from '@angular/core';
import { provideHttpClient } from '@angular/common/http';
import { provideApi, AgravityPublicConfiguration } from '@agravity/public';
export const appConfig: ApplicationConfig = {
providers: [
// ...
provideHttpClient(),
{
provide: AgravityPublicConfiguration,
useFactory: (authService: AuthService) => new AgravityPublicConfiguration({
basePath: 'http://localhost:9999',
withCredentials: true,
username: authService.getUsername(),
password: authService.getPassword(),
}),
deps: [AuthService],
multi: false
}
],
};
`
In order to use multiple APIs generated from different OpenAPI files,
you can create an alias name when importing the modules
in order to avoid naming conflicts:
`typescript
import { provideApi as provideUserApi } from 'my-user-api-path';
import { provideApi as provideAdminApi } from 'my-admin-api-path';
import { HttpClientModule } from '@angular/common/http';
import { environment } from '../environments/environment';
export const appConfig: ApplicationConfig = {
providers: [
// ...
provideHttpClient(),
provideUserApi(environment.basePath),
provideAdminApi(environment.basePath),
],
};
`
Without further customization, only [path-parameters][parameter-locations-url] of [style][style-values-url] 'simple'
and Dates for format 'date-time' are encoded correctly.
Other styles (e.g. "matrix") are not that easy to encode
and thus are best delegated to other libraries (e.g.: [@honoluluhenk/http-param-expander]).
To implement your own parameter encoding (or call another library),
pass an arrow-function or method-reference to the encodeParam property of the Configuration-object
(see General Usage above).
Example value for use in your Configuration-Provider:
`typescript``
new Configuration({
encodeParam: (param: Param) => myFancyParamEncoder(param),
})
[parameter-locations-url]: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-locations
[style-values-url]: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-values
[@honoluluhenk/http-param-expander]: https://www.npmjs.com/package/@honoluluhenk/http-param-expander