Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

How it works:

Digizuite offers an automation which can be triggered based on your requirements. Often it will be on all new product images being uploaded into the platform. Since this is in our automation, it is completely customized what should trigger so you could do it for certain metadata or workflow stages.

...

These endpoints are the ones which is used in the automation config further down.

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

Ximilar AI

Remove.bg as replaced asset

https://

dgz-integration-broker

{URL-DEPENDING-ON-DAM-VERSION}.azurewebsites.net/api/integrations/asset/invoke?clientId={SECRET_CLIENT_ID}&integrationType=

XimilarRemoveBackgroundAiService

RemoveBgService&assetId=<assetid>&code={SECRET_CODE}

  • clientId: provided by Digizuite

  • integrationType:

XimilarRemoveBackgroundAiService
  • 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

replaced

NEW asset

https://

dgz-integration-broker

{URL-DEPENDING-ON-DAM-VERSION}.azurewebsites.net/api/integrations/asset/invoke?clientId={SECRET_CLIENT_ID}&integrationType=

RemoveBgService

RemoveBgServiceNewAsset&assetId=<assetid>&code={SECRET_CODE}

  • clientId: provided by Digizuite

  • integrationType:

removebgservice
  • RemoveBgServiceNewAsset

  • code: provided by digizuite

Replace existing image directly

Creates a new asset from this asset

Note

Notice that it

replaces

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

(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

ClippingMagic as

NEW

replaced asset

https://

dgz-integration-broker

{URL-DEPENDING-ON-DAM-VERSION}.azurewebsites.net/api/integrations/asset/invoke?clientId={SECRET_CLIENT_ID}&integrationType=

RemoveBgServiceNewAsset

ClippingMagicRemoveBgService&assetId=<assetid>&code={SECRET_CODE}

  • clientId: provided by Digizuite

  • integrationType:

RemoveBgServiceNewAsset
  • ClippingMagicRemoveBgService

  • code: provided by digizuite

Replace existing image directly

Note

Notice that it

replaces

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.

...

Code Block
trigger "Metadata trigger" {
    type = "Specific Metadata Value"
    resolves = "Set String Metafield"
    value = "#54a0ff;creative"
    ignore_casing = "true"
    meta_field = "guid:6fe35f10-c810-497b-af9c-e52c3d583593"
    listen_to_metadata_changes = "all"
}

action "Invoke Endpoint" {
    type = "Invoke Endpoint"
    endpoint = "https://dgz-integration-broker{URL-DEPENDING-ON-DAM-VERSION}.azurewebsites.net/api/integrations/asset/invoke?clientId={SECRET_CLIENT_ID}&integrationType=RemoveBgService&assetId=<assetid>&code={SECRET_CODE}"
    method = "post"
    response = "@response"
}

...