Een beleid voor gegevensbeheer maken in de API

De Dienst API van het Beleidstaat u toe om het beleid van het gegevensbeheer tot stand te brengen en te beheren om te bepalen welke marketing acties tegen gegevens kunnen worden genomen die bepaalde etiketten van het gegevensgebruik bevatten.

Dit document bevat een stapsgewijze zelfstudie voor het maken van een beheerbeleid met de API van Policy Service .

Aan de slag

Deze zelfstudie vereist een goed begrip van de volgende belangrijke concepten betrokken bij het creëren en evalueren van beleid:

Alvorens dit leerprogramma te beginnen, te herzien gelieve de ontwikkelaarsgidsvoor belangrijke informatie die u moet kennen om vraag aan Policy Service API met succes te maken, met inbegrip van vereiste kopballen en hoe te om voorbeeld API vraag te lezen.

Een marketingactie definiëren define-action

In het kader van gegevensbeheer is een marketingactie een actie die een Experience Platform gegevensconsument onderneemt en waarvoor moet worden gecontroleerd op overtredingen van het gegevensgebruiksbeleid.

De eerste stap bij het creëren van een beleid van het gegevensgebruik is te bepalen welke marketing actie het beleid zal evalueren. U kunt dit op een van de volgende manieren doen:

Een bestaande marketingactie opzoeken look-up

U kunt bestaande marketingacties opzoeken die door uw beleid moeten worden geëvalueerd door een GET-aanvraag in te dienen bij een van de eindpunten van /marketingActions .

API formaat

Afhankelijk van of u een marketingactie wilt zoeken die wordt geleverd door Experience Platform of een aangepaste marketingactie die door uw organisatie is gemaakt, gebruikt u respectievelijk de eindpunten marketingActions/core of marketingActions/custom .

GET /marketingActions/core
GET /marketingActions/custom

Verzoek

Het volgende verzoek gebruikt het marketingActions/custom eindpunt, dat een lijst van alle marketing acties haalt die door uw organisatie worden bepaald.

curl -X GET \
  https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Reactie

Een geslaagde reactie retourneert het totale aantal gevonden marketingacties (count) en geeft de details van de marketingacties zelf weer binnen de array children .

{
    "_page": {
        "start": "sampleMarketingAction",
        "count": 2
    },
    "_links": {
        "page": {
            "href": "https://platform.adobe.io/marketingActions/custom?{?limit,start,property}",
            "templated": true
        }
    },
    "children": [
        {
            "name": "sampleMarketingAction",
            "description": "Marketing Action description.",
            "imsOrg": "{ORG_ID}",
            "created": 1550714012088,
            "createdClient": "{CREATED_CLIENT}",
            "createdUser": "{CREATED_USER}",
            "updated": 1550714012088,
            "updatedClient": "{UPDATED_CLIENT}",
            "updatedUser": "{UPDATED_USER}",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/custom/sampleMarketingAction"
                }
            }
        },
        {
            "name": "newMarketingAction",
            "description": "Another marketing action.",
            "imsOrg": "{ORG_ID}",
            "created": 1550793833224,
            "createdClient": "{CREATED_CLIENT}",
            "createdUser": "{CREATED_USER}",
            "updated": 1550793833224,
            "updatedClient": "{UPDATED_CLIENT}",
            "updatedUser": "{UPDATED_USER}",
            "_links": {
                "self": {
                    "href": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/custom/newMarketingAction"
                }
            }
        }
    ]
}

Wanneer u de marketingactie vindt die u wilt gebruiken, neemt u de waarde van de eigenschap href op. Deze waarde wordt gebruikt tijdens de volgende stap van creërend een beleid.

Nieuwe marketingactie maken create-new

U kunt een nieuwe marketing actie tot stand brengen door een verzoek van de PUT aan het /marketingActions/custom/ eindpunt te doen en een naam voor de marketing actie te verstrekken aan het eind van de verzoekweg.

API formaat

PUT /marketingActions/custom/{MARKETING_ACTION_NAME}

Verzoek

Het volgende verzoek leidt tot een nieuwe douanemarketing actie genoemd "exportToThirdParty". De waarde name in de aanvraaglading is gelijk aan de naam die is opgegeven in het aanvraagpad.

curl -X PUT \
  https://platform.adobe.io/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "exportToThirdParty",
      "description": "Export data to a third party"
    }'

Reactie

Een geslaagde reactie retourneert HTTP-status 201 (Gemaakt) en de details van de nieuwe marketingactie.

{
    "name": "exportToThirdParty",
    "description": "Export data to a third party",
    "imsOrg": "{ORG_ID}",
    "created": 1550713341915,
    "createdClient": "{CREATED_CLIENT}",
    "createdUser": "{CREATED_USER",
    "updated": 1550713856390,
    "updatedClient": "{UPDATED_CLIENT}",
    "updatedUser": "{UPDATED_USER}",
    "_links": {
        "self": {
            "href": "https://platform.adobe.io:443/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
        }
    }
}

Registreer de URI-id van de zojuist gemaakte marketingactie, zoals deze wordt gebruikt in de volgende stap van het maken van een beleid.

Een beleid maken create-policy

Als u een nieuw beleid wilt maken, moet u de URI-id van een marketingactie opgeven met een expressie van de gebruikslabels die die marketingactie verbiedt.

Deze expressie wordt een beleidsexpressie genoemd en is een object dat (A) een label of (B) een operator en operanden bevat, maar niet beide. Elke operand is op zijn beurt ook een beleidsexpressieobject. Een beleid voor het exporteren van gegevens naar een derde kan bijvoorbeeld worden verboden als C1 OR (C3 AND C7) -labels aanwezig zijn. Deze expressie wordt opgegeven als:

"deny": {
  "operator": "OR",
  "operands": [
    {
      "label": "C1"
    },
    {
      "operator": "AND",
      "operands": [
        {
          "label": "C3"
        },
        {
          "label": "C7"
        }
      ]
    }
  ]
}

Zodra u uw beleidsuitdrukking hebt gevormd, kunt u een nieuw beleid tot stand brengen door een verzoek van de POST aan het /policies/custom eindpunt te doen.

API formaat

POST /policies/custom

Verzoek

Met het volgende verzoek wordt een beleid gemaakt met de naam "Gegevens exporteren naar derden" door een marketingactie en een beleidsexpressie op te geven in de payload van het verzoek.

curl -X POST \
  https://platform.adobe.io/data/foundation/dulepolicy/policies/custom \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "name": "Export Data to Third Party",
    "status": "DRAFT",
    "marketingActionRefs": [
      "../marketingActions/custom/exportToThirdParty"
    ],
    "description": "Conditions under which data cannot be exported to a third party",
    "deny": {
      "operator": "OR",
      "operands": [
        {"label": "C1"},
        {
          "operator": "AND",
          "operands": [
            {"label": "C3"},
            {"label": "C7"}
          ]
        }
      ]
    }
  }'

Reactie

Een geslaagde reactie retourneert HTTP-status 201 (Gemaakt) en de details van het nieuwe beleid.

{
    "name": "Export Data to Third Party",
    "status": "DRAFT",
    "marketingActionRefs": [
        "https://platform-stage.adobe.io:443/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
    ],
    "description": "Conditions under which data cannot be exported to a third party",
    "deny": {
        "operator": "OR",
        "operands": [
            {
                "label": "C1"
            },
            {
                "operator": "AND",
                "operands": [
                    {
                        "label": "C3"
                    },
                    {
                        "label": "C7"
                    }
                ]
            }
        ]
    },
    "imsOrg": "{ORG_ID}",
    "created": 1565651746693,
    "createdClient": "{CREATED_CLIENT}",
    "createdUser": "{CREATED_USER",
    "updated": 1565651746693,
    "updatedClient": "{UPDATED_CLIENT}",
    "updatedUser": "{UPDATED_USER}",
    "_links": {
        "self": {
            "href": "https://platform-stage.adobe.io/data/foundation/dulepolicy/policies/custom/5d51f322e553c814e67af1a3"
        }
    },
    "id": "5d51f322e553c814e67af1a3"
}

Registreer URI identiteitskaart van het onlangs gecreëerde beleid, aangezien het in de volgende stap wordt gebruikt om het beleid toe te laten.

Het beleid inschakelen

Beleid waarvoor de eigenschap status is ingesteld op DRAFT , neemt standaard niet deel aan de evaluatie. U kunt uw beleid voor evaluatie toelaten door een verzoek van PATCH aan het /policies/custom/ eindpunt te doen en het unieke herkenningsteken voor het beleid aan het eind van de verzoekweg te verstrekken.

API formaat

PATCH /policies/custom/{POLICY_ID}

Verzoek

De volgende aanvraag voert een PATCH-bewerking uit op de eigenschap status van het beleid, waarbij de waarde van DRAFT in ENABLED wordt gewijzigd.

curl -X PATCH \
  https://platform.adobe.io/data/foundation/dulepolicy/policies/custom/5d51f322e553c814e67af1a3
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '[
    {
      "op": "replace",
      "path": "/status",
      "value": "ENABLED"
    }
  ]'

Reactie

Een geslaagde reactie retourneert HTTP-status 200 (OK) en de details van het bijgewerkte beleid, waarbij status nu is ingesteld op ENABLED .

{
    "name": "Export Data to Third Party",
    "status": "ENABLED",
    "marketingActionRefs": [
        "https://platform-stage.adobe.io:443/data/foundation/dulepolicy/marketingActions/custom/exportToThirdParty"
    ],
    "description": "Conditions under which data cannot be exported to a third party",
    "deny": {
        "operator": "OR",
        "operands": [
            {
                "label": "C1"
            },
            {
                "operator": "AND",
                "operands": [
                    {
                        "label": "C3"
                    },
                    {
                        "label": "C7"
                    }
                ]
            }
        ]
    },
    "imsOrg": "{ORG_ID}",
    "created": 1565651746693,
    "createdClient": "{CREATED_CLIENT}",
    "createdUser": "{CREATED_USER}",
    "updated": 1565723012139,
    "updatedClient": "{UPDATED_CLIENT}",
    "updatedUser": "{UPDATED_USER}",
    "_links": {
        "self": {
            "href": "https://platform-stage.adobe.io/data/foundation/dulepolicy/policies/custom/5d51f322e553c814e67af1a3"
        }
    },
    "id": "5d51f322e553c814e67af1a3"
}

Volgende stappen

Aan de hand van deze zelfstudie hebt u een beleid voor gegevensgebruik voor een marketingactie gemaakt. U kunt nu aan het leerprogramma blijven op afdwingend beleid van het gegevensgebruikleren hoe te om beleidsschendingen te controleren en hen te behandelen in uw ervaringstoepassing.

Voor meer informatie over de verschillende beschikbare verrichtingen in Policy Service API, zie de gids van de ontwikkelaar van de Dienst van het Beleid. Voor informatie over hoe te om beleid voor Real-Time Customer Profile gegevens af te dwingen, zie het leerprogramma over afdwingend de naleving van het gegevensgebruik voor publiekssegmenten.

Leren hoe te om gebruiksbeleid in het Experience Platform gebruikersinterface te beheren, zie de gids van de beleidsgebruiker.