Point d’entrée de gestion des environnements de test

Les environnements de test d’Adobe Experience Platform fournissent des environnements de développement isolés qui vous permettent de tester des fonctionnalités, d’exécuter des opérations et de créer des configurations personnalisées sans affecter votre environnement de production. Le point de terminaison /sandboxes de l’API Sandbox vous permet de gérer par programmation les environnements de test dans Platform.

Prise en main

Le point d’entrée dʼAPI utilisé dans ce guide fait partie de lʼ Sandbox API. Avant de poursuivre, consultez le guide de prise en main pour obtenir des liens vers la documentation connexe, un guide de lecture d’exemples d’appels API dans ce document et des informations importantes sur les en-têtes requis pour réussir les appels à une API Experience Platform.

Récupération d’une liste d’environnements de test

Vous pouvez répertorier tous les environnements de test appartenant à votre organisation IMS (principal ou non) en effectuant une requête GET sur le point de terminaison /sandboxes .

Format d’API

GET /sandboxes?{QUERY_PARAMS}
Paramètre Description
{QUERY_PARAMS} Paramètres de requête facultatifs en fonction desquels filtrer les résultats. Voir la section Paramètres de requête pour plus d’informations.

Requête

curl -X GET \
  https://platform.adobe.io/data/foundation/sandbox-management/sandboxes?&limit=4&offset=1 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse

Une réponse réussie renvoie une liste d’environnements de test appartenant à votre organisation, y compris des détails tels que name, title, state et type.

{
    "sandboxes": [
        {
            "name": "prod",
            "title": "Production",
            "state": "active",
            "type": "production",
            "region": "VA7",
            "isDefault": true,
            "eTag": 2,
            "createdDate": "2019-09-04 04:57:24",
            "lastModifiedDate": "2019-09-04 04:57:24",
            "createdBy": "{USER_ID}",
            "modifiedBy": "{USER_ID}"
        },
        {
            "name": "dev",
            "title": "Development",
            "state": "active",
            "type": "development",
            "region": "VA7",
            "isDefault": false,
            "eTag": 1,
            "createdDate": "2019-09-03 22:27:48",
            "lastModifiedDate": "2019-09-03 22:27:48",
            "createdBy": "{USER_ID}",
            "modifiedBy": "{USER_ID}"
        },
        {
            "name": "stage",
            "title": "Staging",
            "state": "active",
            "type": "development",
            "region": "VA7",
            "isDefault": false,
            "eTag": 1,
            "createdDate": "2019-09-03 22:27:48",
            "lastModifiedDate": "2019-09-03 22:27:48",
            "createdBy": "{USER_ID}",
            "modifiedBy": "{USER_ID}"
        },
        {
            "name": "dev-2",
            "title": "Development 2",
            "state": "creating",
            "type": "development",
            "region": "VA7",
            "isDefault": false,
            "eTag": 1,
            "createdDate": "2019-09-07 10:16:02",
            "lastModifiedDate": "2019-09-07 10:16:02",
            "createdBy": "{USER_ID}",
            "modifiedBy": "{USER_ID}"
        }
    ],
    "_page": {
        "limit": 4,
        "count": 4
    },
    "_links": {
        "next": {
            "href": "https://platform.adobe.io:443/data/foundation/sandbox-management/sandboxes/?limit={limit}&offset={offset}",
            "templated": true
        },
        "prev": {
            "href": "https://platform.adobe.io:443/data/foundation/sandbox-management/sandboxes?offset=0&limit=1",
            "templated": null
        },
        "page": {
            "href": "https://platform.adobe.io:443/data/foundation/sandbox-management/sandboxes?offset=1&limit=1",
            "templated": null
        }
    }
}
Propriété Description
name Le nom de l’environnement de test. Cette propriété est utilisée à des fins de recherche dans les appels API.
title Le nom d’affichage de l’environnement de test.
state L’état de traitement actuel de l’environnement de test. Un environnement de test peut avoir l’un des états suivants :
  • creating: L’environnement de test a été créé, mais le système continue de le configurer.
  • active: L’environnement de test est créé et principal.
  • failed: En raison d’une erreur, le système n’a pas pu configurer l’environnement de test et est désactivé.
  • deleted: L’environnement de test a été désactivé manuellement.
type Type d’environnement de test. Les types d’environnements de test actuellement pris en charge sont development et production.
isDefault Une propriété booléenne indiquant si cet environnement de test est l’environnement de test de production par défaut pour l’organisation.
eTag L’identifiant d’une version spécifique de l’environnement de test. Utilisée pour le contrôle des versions et une mise en cache efficace, cette valeur est mise à jour chaque fois que l’environnement de test est modifié.

Recherche d’un environnement de test

Vous pouvez rechercher un environnement de test individuel en effectuant une requête GET comprenant la propriété name de l’environnement de test dans le chemin de requête.

Format d’API

GET /sandboxes/{SANDBOX_NAME}
Paramètre Description
{SANDBOX_NAME} La propriété name de l’environnement de test que vous souhaitez rechercher.

Requête

La requête suivante récupère un environnement de test nommé « dev-2 ».

curl -X GET \
  https://platform.adobe.io/data/foundation/sandbox-management/sandboxes/dev-2 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \

Réponse

Une réponse réussie renvoie les détails de l’environnement de test, y compris son name, title, state et type.

{
    "name": "dev-2",
    "title": "Development 2",
    "state": "creating",
    "type": "development",
    "region": "VA7",
    "isDefault": false,
    "eTag": 1,
    "createdDate": "2019-09-07 10:16:02",
    "lastModifiedDate": "2019-09-07 10:16:02",
    "createdBy": "{USER_ID}",
    "modifiedBy": "{USER_ID}"
}
Propriété Description
name Le nom de l’environnement de test. Cette propriété est utilisée à des fins de recherche dans les appels API.
title Le nom d’affichage de l’environnement de test.
state L’état de traitement actuel de l’environnement de test. L’état d’un environnement de test peut correspondre à l’un des suivants :
  • création : l’environnement de test a été créé, mais le système continue de le configurer.
  • actif : l’environnement de test est créé et actif.
  • échec : en raison d’une erreur, le système n’a pas pu configurer l’environnement de test et a été désactivé.
  • supprimé : l’environnement de test a été désactivé manuellement.
type Type d’environnement de test. Les types d’environnements de test actuellement pris en charge sont les suivants : development et production.
isDefault Une propriété booléenne indiquant s’il s’agit de l’environnement de test par défaut de l’organisation. Il s’agit généralement de l’environnement de test de production.
eTag L’identifiant d’une version spécifique de l’environnement de test. Utilisée pour le contrôle des versions et une mise en cache efficace, cette valeur est mise à jour chaque fois que l’environnement de test est modifié.

Création d’un environnement de test

REMARQUE

Lorsqu’un nouvel environnement de test est créé, vous devez d’abord ajouter ce nouvel environnement de test à votre profil de produit dans Adobe Admin Console avant de pouvoir commencer à utiliser le nouvel environnement de test. Pour plus d’informations sur la configuration d’un environnement de test à un profil de produit, voir la documentation sur la gestion des autorisations pour un profil de produit .

Vous pouvez créer un environnement de test de développement ou de production en envoyant une requête de POST au point de terminaison /sandboxes .

Création d’un environnement de test de développement

Pour créer un environnement de test de développement, vous devez fournir un attribut type avec la valeur development dans le payload de la requête.

Format d’API

POST /sandboxes

Requête

La requête suivante crée un nouvel environnement de test de développement nommé "acme-dev".

curl -X POST \
  https://platform.adobe.io/data/foundation/sandbox-management/sandboxes \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "acme-dev",
    "title": "Acme Business Group dev",
    "type": "development"
  }'
Propriété Description
name Identifiant qui sera utilisé pour accéder à l’environnement de test lors de futures requêtes. Cette valeur doit être unique, et il est recommandé de la décrire le plus précisément possible. Cette valeur ne peut pas contenir d’espaces ni de caractères spéciaux.
title Nom compréhensible utilisé à des fins d’affichage dans l’interface utilisateur de Platform.
type Type d’environnement de test à créer. Pour un environnement de test hors production, cette valeur doit être development.

Réponse

Une réponse réussie renvoie les détails du nouvel environnement de test, indiquant que son state est « création ».

{
    "name": "acme-dev",
    "title": "Acme Business Group dev",
    "state": "creating",
    "type": "development",
    "region": "VA7"
}
REMARQUE

Les environnements de test prennent environ 30 secondes pour être configurés par le système, après quoi leur state deviendra "principal" ou "échec".

Création d’un environnement de test de production

Pour créer un environnement de test de production, vous devez fournir un attribut type avec la valeur production dans le payload de la requête.

Format d’API

POST /sandboxes

Requête

La requête suivante crée un nouvel environnement de test de production nommé "acme".

curl -X POST \
  https://platform.adobe.io/data/foundation/sandbox-management/sandboxes \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H `Accept: application/json` \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "acme",
    "title": "Acme Business Group",
    "type": "production"
}'
Propriété Description
name Identifiant qui sera utilisé pour accéder à l’environnement de test lors de futures requêtes. Cette valeur doit être unique, et il est recommandé de la décrire le plus précisément possible. Cette valeur ne peut pas contenir d’espaces ni de caractères spéciaux.
title Nom compréhensible utilisé à des fins d’affichage dans l’interface utilisateur de Platform.
type Type d’environnement de test à créer. Pour un environnement de test de production, cette valeur doit être production.

Réponse

Une réponse réussie renvoie les détails du nouvel environnement de test, indiquant que son state est « création ».

{
    "name": "acme",
    "title": "Acme Business Group",
    "state": "creating",
    "type": "production",
    "region": "VA7"
}
REMARQUE

Les environnements de test prennent environ 30 secondes pour être configurés par le système, après quoi leur state deviendra "principal" ou "échec".

Mise à jour d’un environnement de test

Vous pouvez mettre à jour un ou plusieurs champs d’un environnement de test en effectuant une requête PATCH incluant le name de l’environnement de test dans le chemin de requête et la propriété à mettre à jour dans le payload de la requête.

REMARQUE

Actuellement, seule la propriété title d’un environnement de test peut être mise à jour.

Format d’API

PATCH /sandboxes/{SANDBOX_NAME}
Paramètre Description
{SANDBOX_NAME} La propriété name de l’environnement de test que vous souhaitez mettre à jour.

Requête

La requête suivante met à jour la propriété title de l’environnement de test nommé "acme".

curl -X PATCH \
  https://platform.adobe.io/data/foundation/sandbox-management/sandboxes/acme \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'Content-Type: application/json'
  -d '{
    "title": "Acme Business Group prod"
  }'

Réponse

Une réponse réussie renvoie un état HTTP 200 (OK) avec les détails de l’environnement de test mis à jour.

{
    "name": "acme",
    "title": "Acme Business Group prod",
    "state": "active",
    "type": "production",
    "region": "VA7"
}

Réinitialisation d’un environnement de test

Les environnements de test disposent d’une fonctionnalité de "réinitialisation d’usine" qui supprime toutes les ressources autres que les ressources par défaut d’un environnement de test. Vous pouvez réinitialiser un environnement de test en effectuant une requête PUT comprenant le name de l’environnement de test dans le chemin d’accès de la requête.

Format d’API

PUT /sandboxes/{SANDBOX_NAME}
Paramètre Description
{SANDBOX_NAME} La propriété name de l’environnement de test que vous souhaitez réinitialiser.
validationOnly Paramètre facultatif qui vous permet d’effectuer une vérification avant vol sur l’opération de réinitialisation de l’environnement de test sans effectuer la requête réelle. Définissez ce paramètre sur validationOnly=true pour vérifier si l’environnement de test que vous êtes sur le point de réinitialiser contient des données Adobe Analytics, Adobe Audience Manager ou de partage de segment.

Requête

La requête suivante réinitialise un environnement de test nommé "acme-dev".

curl -X PUT \
  https://platform.adobe.io/data/foundation/sandbox-management/sandboxes/acme-dev?validationOnly=true \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'Content-Type: application/json'
  -d '{
    "action": "reset"
  }'
Propriété Description
action Ce paramètre doit être fourni dans le payload de la requête avec une valeur « reset » pour réinitialiser l’environnement de test.

Réponse

REMARQUE

Une fois qu’un environnement de test est réinitialisé, il faut compter environ 30 secondes pour qu’il soit configuré par le système.

Une réponse réussie renvoie les détails de l’environnement de test mis à jour, indiquant que son state est « resetting ».

{
    "id": "d8184350-dbf5-11e9-875f-6bf1873fec16",
    "name": "acme-dev",
    "title": "Acme Business Group dev",
    "state": "resetting",
    "type": "development",
    "region": "VA7"
}

L’environnement de test de production par défaut et les environnements de test de production créés par l’utilisateur ne peuvent pas être réinitialisés si le graphique d’identités qui y est hébergé est également utilisé par Adobe Analytics pour la fonction Analyse entre appareils (CDA) ou si le graphique d’identités hébergé est également utilisé par Adobe Audience Manager pour la fonction Destinations basées sur les personnes (PBD)).

Voici une liste d’exceptions possibles qui peuvent empêcher la réinitialisation d’un environnement de test :

{
    "status": 400,
    "title": "Sandbox `{SANDBOX_NAME}` cannot be reset. The identity graph hosted in this sandbox is also being used by Adobe Analytics for the Cross Device Analytics (CDA) feature.",
    "type": "http://ns.adobe.com/aep/errors/SMS-2074-400"
},
{
    "status": 400,
    "title": "Sandbox `{SANDBOX_NAME}` cannot be reset. The identity graph hosted in this sandbox is also being used by Adobe Audience Manager for the People Based Destinations (PBD) feature.",
    "type": "http://ns.adobe.com/aep/errors/SMS-2075-400"
},
{
    "status": 400,
    "title": "Sandbox `{SANDBOX_NAME}` cannot be reset. The identity graph hosted in this sandbox is also being used by Adobe Audience Manager for the People Based Destinations (PBD) feature, as well by Adobe Analytics for the Cross Device Analytics (CDA) feature.",
    "type": "http://ns.adobe.com/aep/errors/SMS-2076-400"
},
{
    "status": 400,
    "title": "Warning: Sandbox `{SANDBOX_NAME}` is used for bi-directional segment sharing with Adobe Audience Manager or Audience Core Service.",
    "type": "http://ns.adobe.com/aep/errors/SMS-2077-400"
}

Vous pouvez procéder à la réinitialisation d’un environnement de test de production utilisé pour le partage bidirectionnel de segments avec Audience Manager ou Audience Core Service en ajoutant le paramètre ignoreWarnings à votre requête.

Format d’API

PUT /sandboxes/{SANDBOX_NAME}?ignoreWarnings=true
Paramètre Description
{SANDBOX_NAME} La propriété name de l’environnement de test que vous souhaitez réinitialiser.
ignoreWarnings Paramètre facultatif qui vous permet d’ignorer la vérification de validation et de forcer la réinitialisation d’un environnement de test de production utilisé pour le partage de segments bidirectionnel avec Audience Manager ou Audience Core Service. Ce paramètre ne peut pas être appliqué à un environnement de test de production par défaut.

Requête

La requête suivante réinitialise un environnement de test de production nommé "acme".

curl -X PUT \
  https://platform.adobe.io/data/foundation/sandbox-management/sandboxes/acme?ignoreWarnings=true \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'Content-Type: application/json'
  -d '{
    "action": "reset"
  }'

Réponse

Une réponse réussie renvoie les détails de l’environnement de test mis à jour, indiquant que son state est « resetting ».

{
    "id": "d8184350-dbf5-11e9-875f-6bf1873fec16",
    "name": "acme",
    "title": "Acme Business Group prod",
    "state": "resetting",
    "type": "production",
    "region": "VA7"
}

Suppression d’un environnement de test

IMPORTANT

L’environnement de test de production par défaut ne peut pas être supprimé.

Vous pouvez supprimer un environnement de test en effectuant une requête DELETE qui inclut le name de l’environnement de test dans le chemin de la requête.

REMARQUE

L’appel de cette API met à jour la propriété status de l’environnement de test sur « supprimé » et la désactive. Les requêtes GET peuvent toujours récupérer les détails de l’environnement de test après sa suppression.

Format d’API

DELETE /sandboxes/{SANDBOX_NAME}
Paramètre Description
{SANDBOX_NAME} name de l’environnement de test que vous souhaitez supprimer.
validationOnly Paramètre facultatif qui vous permet de vérifier en amont l’opération de suppression de l’environnement de test sans effectuer la requête réelle. Définissez ce paramètre sur validationOnly=true pour vérifier si l’environnement de test que vous êtes sur le point de réinitialiser contient des données Adobe Analytics, Adobe Audience Manager ou de partage de segment.
ignoreWarnings Paramètre facultatif qui vous permet d’ignorer la vérification de validation et de forcer la suppression d’un environnement de test de production créé par l’utilisateur qui est utilisé pour le partage bidirectionnel de segments avec Audience Manager ou Audience Core Service. Ce paramètre ne peut pas être appliqué à un environnement de test de production par défaut.

Requête

La requête suivante supprime un environnement de test de production nommé "acme".

curl -X DELETE \
  https://platform.adobe.io/data/foundation/sandbox-management/sandboxes/acme?ignoreWarnings=true \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}'

Réponse

Une réponse réussie renvoie les détails mis à jour de l’environnement de test, indiquant que son state est « supprimé ».

{
    "name": "acme",
    "title": "Acme Business Group prod",
    "state": "deleted",
    "type": "development",
    "region": "VA7"
}

Sur cette page