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.

Met deze API kunt u uw beslissingsinhoud naadloos overbrengen tussen omgevingen (bijvoorbeeld van ontwikkeling naar staging of staging naar productie) en tegelijk de integriteit en relaties van de gegevens behouden.

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.

Basisprincipes van API's api-basics

Basis-URL's base-urls

Gebruik de volgende basis-URL's, afhankelijk van uw omgeving:

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

Het migratieproces bestaat uit twee hoofdstappen: het analyseren van afhankelijkheden en het uitvoeren van de migratie. Voer de volgende stappen uit om een geslaagde migratie te garanderen.

Stap 1: Afhankelijkheden analyseren analyze-dependencies

Voordat u gaat migreren, gebruikt u de afhankelijkheidsworkflow om te bepalen wat er moet worden toegewezen van beslissingsbeheer aan besluitvorming in de doelsandbox. Met deze analyse kunt u de relaties tussen objecten begrijpen en de benodigde toewijzingen voorbereiden.

Een afhankelijkheidsworkflow maken create-dependency-workflow

Gebruik de volgende API-aanroep om een workflow voor afhankelijkheidsanalyse te maken.

API formaat

POST /migration/service/dependency

zandbak-vlakke gebiedsdeel (geadviseerd eerst)

Begin met een zandbak-vlakke analyse om een volledige mening van alle gebiedsdelen te krijgen:

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

Offer-vlakke gebiedsdeel

Als u alleen afhankelijkheden voor specifieke aanbiedingen wilt analyseren, stelt u requestLevel: "offer" in en verstrekt u een offersList -array met de aanbod-id's die u wilt analyseren.

besluit-vlakke gebiedsdeel

Als u alleen afhankelijkheden voor specifieke beslissingen wilt analyseren, stelt u requestLevel: "decision" in en verstrekt u een decisionsList -array met de beslissing-id's die u wilt analyseren.

Status afhankelijkheidswerkstroom controleren poll-dependency-status

Opiniepeilen de afhankelijkheidsworkflow om te controleren of de analyse is voltooid.

API formaat

GET /migration/service/dependency/{id}

Verzoek

curl --request GET \
  --url "https://platform.adobe.io/migration/service/dependency/<WORKFLOW_ID>" \
  --header "Authorization: Bearer <IMS_ACCESS_TOKEN>" \
  --header "x-gw-ims-org-id: <IMS_ORG_ID>" \
  --header "x-api-key: <CLIENT_API_KEY>"

Wanneer het veld status Completed weergeeft, is de afhankelijkheidsanalyse gereed. Gebruik de workflowuitvoer om uw migratie-afhankelijkheidstoewijzingen te maken:

Stap 2: De migratie uitvoeren 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 /migration/service/migrations

zandbak-vlakke migratie

Alle beslissingsobjecten migreren van de ene naar de andere sandbox:

curl --request POST \
  --url "https://platform.adobe.io/migration/service/migrations" \
  --header "Authorization: Bearer <IMS_ACCESS_TOKEN>" \
  --header "x-gw-ims-org-id: <IMS_ORG_ID>" \
  --header "x-api-key: <CLIENT_API_KEY>" \
  --header "Content-Type: application/json" \
  --data '{
    "imsOrgId": "<IMS_ORG_ID>",
    "sourceSandboxDetails": { "sandboxName": "<SOURCE_SANDBOX_NAME>" },
    "targetSandboxDetails": { "sandboxName": "<TARGET_SANDBOX_NAME>" },
    "createDataStream": true,
    "dependency": {
      "profileAttributeDependency": {
        "sourceAttr1": "targetAttr1"
      },
      "segmentsDependency": {
        "sourceSegmentKey1": {
          "segmentNamespace": "<TARGET_SEGMENT_NAMESPACE>",
          "segmentId": "<TARGET_SEGMENT_ID>"
        }
      },
      "contextAttributeDependency": {
        "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 /migration/service/migrations/{id}

Verzoek

curl --request GET \
  --url "https://platform.adobe.io/migration/service/migrations/<WORKFLOW_ID>" \
  --header "Authorization: Bearer <IMS_ACCESS_TOKEN>" \
  --header "x-gw-ims-org-id: <IMS_ORG_ID>" \
  --header "x-api-key: <CLIENT_API_KEY>"

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 /migration/service/rollbacks/{migrationWorkflowId}

Vervang {migrationWorkflowId} door de id van de migratieworkflow die u wilt terugdraaien.

Verzoek

curl --request POST \
  --url "https://platform.adobe.io/migration/service/rollbacks/<MIGRATION_WORKFLOW_ID>" \
  --header "Authorization: Bearer <IMS_ACCESS_TOKEN>" \
  --header "x-gw-ims-org-id: <IMS_ORG_ID>" \
  --header "x-api-key: <CLIENT_API_KEY>"

Terugdraaistatus van monitor poll-rollback-status

Opiniepeiling de terugdraaiworkflow om de voortgang te volgen.

API formaat

GET /migration/service/rollbacks/{rollbackWorkflowId}

Verzoek

curl --request GET \
  --url "https://platform.adobe.io/migration/service/rollbacks/<ROLLBACK_WORKFLOW_ID>" \
  --header "Authorization: Bearer <IMS_ACCESS_TOKEN>" \
  --header "x-gw-ims-org-id: <IMS_ORG_ID>" \
  --header "x-api-key: <CLIENT_API_KEY>"

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 middelen van het werkschema kunnen door de dienstgebruikers slechts worden geschrapt. Voor verwijderingsbewerkingen is een If-Match header met de _etag -waarde van de workflow vereist.

Beschikbare schrappingsverrichtingen:

Verwante onderwerpen related-topics