Migratie-API voor besluitvorming decisioning-migration-api

Met de API voor beslissingsmigratieservice kunt u beslissingsbeheerobjecten migreren van de ene naar de andere sandbox. Het migratieproces wordt uitgevoerd als asynchrone workflows die afhankelijkheidsanalyse, uitvoering en optionele terugdraaimogelijkheden omvatten.

Deze API staat u toe om uw beslissingsinhoud tussen milieu’s foutloos over te brengen terwijl het handhaven van gegevensintegriteit en verhoudingen.

Om over de voordelen en de mogelijkheden van Beslissing in vergelijking met het beheer van het Besluit te leren, verwijs naar ​ deze pagina ​.

Mogelijkheden capabilities

De API voor de beslissingsmigratieservice biedt de volgende mogelijkheden:

Vereisten prerequisites

Vereiste machtigingen permissions

Als u de migratie-API wilt gebruiken, hebt u de juiste machtigingen nodig in zowel de bron- als doelsandboxen:

zandbak van Source - lees toegang tot de voorwerpen van het Beslissingsbeheer

zandbak van het Doel - creeer en geef toegang tot Beslissende voorwerpen uit

Tot de gebruikelijke machtigingen behoren:

De doelsandbox voorbereiden target-sandbox-preparation

Controleer voordat u een migratie uitvoert of de doelsandbox correct is geconfigureerd:

Voor meer informatie over zandbakbeheer, verwijs naar ​ Gebruik en wijs zandbakken ​ toe.

Basisbeginselen van API api-basics

Basis-URL base-url

Gebruik de volgende basis-URL:

Verificatie authentication

Voor alle API-aanvragen zijn de volgende headers vereist:

Voor gedetailleerde instructies bij vestiging authentificatie, verwijs naar de ​ de authentificatiegids van Journey Optimizer ​.

Workflowmodel workflow-model

Elke API-aanroep maakt of haalt een bron van een workflow op. Workflows zijn asynchrone bewerkingen die de voortgang en de resultaten van migratietaken volgen.

Een werkstroom heeft de volgende eigenschappen:

Migratieworkflow migration-workflow

The migration process consists of two main steps: analyzing dependencies and executing the migration. Follow these steps to ensure a successful migration.

Step 1: Analyze dependencies analyze-dependencies

Before migrating, use the dependency workflow to identify what needs to be mapped from Decision management to Decisioning in your target sandbox. This analysis helps you understand the relationships between objects and prepare the necessary mappings.

Create a dependency workflow create-dependency-workflow

Use the following API call to create a dependency analysis workflow.

API formaat

POST /workflows/generate-dependencies

Sandbox-level dependency (recommended first)

Start with a sandbox-level analysis to get a complete view of all dependencies:

curl --request POST \
  --url "https://decisioning-migration.adobe.io/workflows/generate-dependencies" \
  --header "Authorization: Bearer <IMS_ACCESS_TOKEN>" \
  --header "x-gw-ims-org-id: <IMS_ORG_ID>" \
  --header "Content-Type: application/json" \
  --data '{
    "imsOrgId": "<IMS_ORG_ID>",
    "sourceSandboxDetails": { "sandboxName": "<SOURCE_SANDBOX_NAME>" },
    "targetSandboxDetails": { "sandboxName": "<TARGET_SANDBOX_NAME>" },
    "requestLevel": "sandbox"
  }'

Offer-level dependency

To analyze dependencies for specific offers only, set requestLevel: "offer" and provide an offersList array with the offer IDs you want to analyze.

Decision-level dependency

To analyze dependencies for specific decisions only, set requestLevel: "decision" and provide a decisionsList array with the decision IDs you want to analyze.

Check dependency workflow status poll-dependency-status

Poll the dependency workflow to check when the analysis is complete.

API formaat

GET /workflows/generate-dependencies/{id}

Verzoek

curl --request GET \
  --url "https://decisioning-migration.adobe.io/workflows/generate-dependencies/<WORKFLOW_ID>" \
  --header "Authorization: Bearer <IMS_ACCESS_TOKEN>" \
  --header "x-gw-ims-org-id: <IMS_ORG_ID>"

When the status field shows Completed, the dependency analysis is ready. Use the workflow output to build your migration dependency mappings:

Step 2: Execute the migration execute-migration

Nadat u de afhankelijkheden hebt geanalyseerd en uw toewijzingen hebt voorbereid, kunt u de migratie uitvoeren.

Een migratieworkflow maken create-migration-workflow

Gebruik de gebiedsafhankelijkheidstoewijzingen van Stap 1 om uw migratie te vormen en uit te voeren.

API formaat

POST /workflows/migration

zandbak-vlakke migratie

Alle beslissingsobjecten migreren van de ene naar de andere sandbox:

curl --request POST \
  --url "https://decisioning-migration.adobe.io/workflows/migration" \
  --header "Authorization: Bearer <IMS_ACCESS_TOKEN>" \
  --header "x-gw-ims-org-id: <IMS_ORG_ID>" \
  --header "Content-Type: application/json" \
  --data '{
    "imsOrgId": "<IMS_ORG_ID>",
    "sourceSandboxDetails": { "sandboxName": "<SOURCE_SANDBOX_NAME>" },
    "targetSandboxDetails": { "sandboxName": "<TARGET_SANDBOX_NAME>" },
    "createDataStream": true,
    "dependency": {
      "profileAttributes": {
        "sourceAttr1": "targetAttr1"
      },
      "segments": {
        "sourceSegmentKey1": {
          "namespace": "<TARGET_SEGMENT_NAMESPACE>",
          "id": "<TARGET_SEGMENT_ID>"
        }
      },
      "contextAttributes": {
        "sourceCtx1": "targetCtx1"
      },
      "datasetName": "<TARGET_DATASET_NAME>"
    },
    "requestLevel": "sandbox"
  }'

verschuiving-vlakke

Als u alleen specifieke aanbiedingen wilt migreren, gebruikt u requestLevel: "offer" en voegt u een array offersList toe:

"offersList": ["offer-id-1", "offer-id-2"]

besluit-vlakke migratie

Als u alleen specifieke beslissingen wilt migreren, gebruikt u requestLevel: "decision" en voegt u een array decisionsList toe:

"decisionsList": ["decision-id-1", "decision-id-2"]

Migratiestatus bewaken poll-migration-status

Opiniepeiling de migratieworkflow om de voortgang ervan te volgen.

API formaat

GET /workflows/migration/{id}

Verzoek

curl --request GET \
  --url "https://decisioning-migration.adobe.io/workflows/migration/<WORKFLOW_ID>" \
  --header "Authorization: Bearer <IMS_ACCESS_TOKEN>" \
  --header "x-gw-ims-org-id: <IMS_ORG_ID>"

de resultaten van de Migratie

Wanneer het veld status Completed weergeeft, is de migratie gelukt. De workflow result bevat:

Wanneer het veld status Failed weergeeft, bekijkt u de array errors[] en het veld result.error voor meer informatie over wat er fout is gegaan.

Uw migratie valideren validate-migration

Nadat de migratie is voltooid, controleert u of alle objecten correct zijn gemigreerd.

Controlelijst voor validatie validation-checklist

Voorbeeld test-runtime-delivery

Als uw migratie een datastream heeft gemaakt, kunt u de levering van de aanbieding testen aan de hand van het volgende voorbeeld:

curl --request POST \
  --url "https://edge.adobedc.net/ee/or2/v1/interact?configId=<DATASTREAM_ID>" \
  --header "Content-Type: application/json" \
  --header "x-request-id: <uuid>" \
  --data '{ "events": [ ... ] }'

Een migratie terugdraaien rollback

Als u tijdens de validatie problemen ontdekt, kunt u een voltooide migratie terugdraaien om de vorige status van de doelsandbox te herstellen.

Een terugdraaiworkflow maken create-rollback-workflow

Start een terugdraaiactie door een terugdraaiworkflow te maken die verwijst naar de migratie die u wilt terugdraaien.

API formaat

POST /workflows/rollback

Verzoek

curl --request POST \
  --url "https://decisioning-migration.adobe.io/workflows/rollback" \
  --header "Authorization: Bearer <IMS_ACCESS_TOKEN>" \
  --header "x-gw-ims-org-id: <IMS_ORG_ID>" \
  --header "Content-Type: application/json" \
  --data '{ "rollbackWorkflowId": "<MIGRATION_WORKFLOW_ID>" }'

Vervang <MIGRATION_WORKFLOW_ID> door de id van de migratieworkflow die u wilt terugdraaien.

Terugdraaistatus van monitor poll-rollback-status

Opiniepeiling de terugdraaiworkflow om de voortgang te volgen.

API formaat

GET /workflows/rollback/{rollbackWorkflowId}

Verzoek

curl --request GET \
  --url "https://decisioning-migration.adobe.io/workflows/rollback/<ROLLBACK_WORKFLOW_ID>" \
  --header "Authorization: Bearer <IMS_ACCESS_TOKEN>" \
  --header "x-gw-ims-org-id: <IMS_ORG_ID>"

Gelijktijdige workflows verwerken handle-concurrency

Met de migratie-API kan slechts één workflow tegelijk per organisatie worden uitgevoerd. Als u probeert om een nieuw werkschema tot stand te brengen terwijl een andere lopend is, zult u a 409 Conflict foutenreactie ontvangen (“een werkschema is reeds lopend…”).

In dit geval wacht u tot de actieve workflow is voltooid of haalt u de workflow-id op en bekijkt u de status. Nadat de huidige workflow is voltooid, kunt u een nieuwe maken.

Koppelingsverwijzing naar entiteit entity-mapping

Bij de migratie van beslissingsbeheer naar besluitvorming worden de entiteiten als volgt toegewezen:

Opschonen van workflow cleanup

De schrapping van het werkschema is niet openbaar beschikbaar. Als u een werkschemabron moet schrappen, contacteer uw systeembeheerder.

Verwante onderwerpen related-topics