...
| Note |
|---|
Pre-requisites:
You need your own account and subscription at Ximilar or Remove.bg. From your account, the actual API Key must be sent to Digizuite so we know where the request should be directed to. If the license is sold with remove.bg included, then that is also an option an you do not have to provide an account. But this will be validated. |
...
| Info |
|---|
Please be aware that 5.8+ have a different URL so go find the right base URL here: Digizuite™ AI Services or ask R&D. But client id and code will be the same. |
Type | Endpoint | Input | Functionality | Output |
|---|
Remove.bg as replaced asset | https://{URL-DEPENDING-ON-DAM-VERSION}.azurewebsites.net/api/integrations/asset/invoke?clientId={SECRET_CLIENT_ID}&integrationType=RemoveBgService&assetId=<assetid>&code={SECRET_CODE}
| clientId: provided by Digizuite integrationType: removebgservice code: provided by digizuite
| Replace existing image directly | Note |
|---|
Notice that it replaces from the function so please having the right clientId for each environment is important. Dev won’t work for prod for instance, and can have massive impact if not used correctly. |
| Returns 200 And the result will be (but in this case the asset will be the same because it is a replace): | Code Block |
|---|
interface UploadResponse {
ItemId: number;
AssetId: number;
} |
|
Remove.bg as NEW asset | https://{URL-DEPENDING-ON-DAM-VERSION}.azurewebsites.net/api/integrations/asset/invoke?clientId={SECRET_CLIENT_ID}&integrationType=RemoveBgServiceNewAsset&assetId=<assetid>&code={SECRET_CODE}
| clientId: provided by Digizuite integrationType: RemoveBgServiceNewAsset code: provided by digizuite
| Creates a new asset from this asset | Note |
|---|
Notice that it UPLOADS from the function so please having the right clientId for each environment is important. Dev won’t work for prod for instance, and can have massive impact if not used correctly. |
| Returns 200 And the result will be: | Code Block |
|---|
interface UploadResponse {
ItemId: number;
AssetId: number;
} |
|
ClippingMagic as replaced asset | https://{URL-DEPENDING-ON-DAM-VERSION}.azurewebsites.net/api/integrations/asset/invoke?clientId={SECRET_CLIENT_ID}&integrationType=ClippingMagicRemoveBgService&assetId=<assetid>&code={SECRET_CODE}
| clientId: provided by Digizuite integrationType: ClippingMagicRemoveBgService code: provided by digizuite
| Replace existing image directly | Note |
|---|
Notice that it UPLOADS from the function so please having the right clientId for each environment is important. Dev won’t work for prod for instance, and can have massive impact if not used correctly. |
| Returns 200 And the result will be: | Code Block |
|---|
interface UploadResponse {
ItemId: number;
AssetId: number;
} |
|
Configuration
The following shows a starting point for your integration.
...