Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

Digizuite currently offers support for two services:

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.

Endpoints

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

Type

Endpoint

Input

Functionality

Output

Remove.bg as replaced asset

https://dgz-integration-broker.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

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):

interface UploadResponse {
   ItemId: number;
   AssetId: number;
}

Remove.bg as NEW asset

https://dgz-integration-broker.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

Replace existing image directly

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:

interface UploadResponse {
   ItemId: number;
   AssetId: number;
}

Configuration

The following shows a starting point for your integration.

Note that client id and secret code must be provided for the endpoint by Digizuite R&D. Also, the ximilar or inscene API key must be provided to Digizuite so it can be associated with the client id.

When you have added the below then you are good to go.

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.azurewebsites.net/api/integrations/asset/invoke?clientId={SECRET_CLIENT_ID}&integrationType=RemoveBgService&assetId=<assetid>&code={SECRET_CODE}"
    method = "post"
    response = "@response"
}

  • No labels