Recuperar una configuración de servidor de destino
Esta página ejemplifica la solicitud de API y la carga útil que puede utilizar para recuperar información sobre una configuración de servidor de destino existente utilizando /authoring/destination-servers Extremo de API.
Para obtener una descripción detallada de las funciones utilizadas por los servidores de destino, lea los siguientes artículos:
Todos los nombres y valores de parámetro admitidos por el Destination SDK son distingue mayúsculas de minúsculas. Para evitar errores de distinción entre mayúsculas y minúsculas, utilice los nombres y valores de los parámetros exactamente como se muestra en la documentación.
Introducción a las operaciones de API del servidor de destino
Antes de continuar, consulte la guía de introducción para obtener información importante que necesita conocer para realizar llamadas correctamente a la API, incluido cómo obtener el permiso de creación de destino requerido y los encabezados necesarios.
Recuperar una configuración de servidor de destino
Puede recuperar una configuración de servidor de destino existente realizando una GET solicitud a la /authoring/destination-servers punto final.
SUGERENCIA
Extremo de API: platform.adobe.io/data/core/activation/authoring/destination-servers
Formato de API
Utilice el siguiente formato de API para recuperar todas las configuraciones del servidor de destino para su cuenta.
GET /authoring/destination-servers
Utilice el siguiente formato de API para recuperar una configuración específica del servidor de destino, definida por la variable {INSTANCE_ID} parámetro.
GET /authoring/destination-servers/{INSTANCE_ID}
Las dos solicitudes siguientes recuperan todas las configuraciones del servidor de destino para su organización IMS o una configuración específica del servidor de destino, en función de si pasa la variable INSTANCE_ID en la solicitud.
Seleccione cada pestaña a continuación para ver la carga útil correspondiente y sus respuestas.
La siguiente solicitud recupera la lista de configuraciones del servidor de destino a las que tiene acceso, según IMS Org ID y la configuración de zona protegida.
Una respuesta correcta devuelve el estado HTTP 200 con una lista de configuraciones de servidor de destino a las que tiene acceso, en función de IMS Org ID y el nombre de la zona protegida que ha utilizado. Uno instanceId corresponde a un servidor de destino. La respuesta de ejemplo siguiente incluye dos configuraciones de servidor de destino.
{
"items":[
{
"instanceId":"2307ec2b-4798-45a4-9239-5d0a2fb0ed67",
"createdDate":"2020-11-17T06:49:24.331012Z",
"lastModifiedDate":"2020-11-17T06:49:24.331012Z",
"name":"Moviestar Destination Server",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"https://go.{% if destination.config.domain == \"US\" %}moviestar.com{% else %}moviestar.eu{% endif%}/api/named_users/tags"
}
},
"httpTemplate":{
"requestBody":{
"templatingStrategy":"PEBBLE_V1",
"value":"{ \"audience\": { \"named_user_id\": [ {% for named_user in input.profile.identityMap.named_user_id %} \"{{ named_user.id }}\"{% if not loop.last %},{% endif %} {% endfor %} ] }, {% if addedSegments(input.profile.segmentMembership.ups) is not empty %} \"add\": { \"adobe-segments\": [ {% for added_segment in addedSegments(input.profile.segmentMembership.ups) %} \"{{ destination.segmentNames[added_segment.key] }}\"{% if not loop.last %},{% endif %} {% endfor %} ] } {% endif %} {% if addedSegments(input.profile.segmentMembership.ups) is not empty and removedSegments(input.profile.segmentMembership.ups) is not empty %} , {% endif %} {% if removedSegments(input.profile.segmentMembership.ups) is not empty %} \"remove\": { \"adobe-segments\": [ {% for removed_segment in removedSegments(input.profile.segmentMembership.ups) %} \"{{ destination.segmentNames[removed_segment.key] }}\"{% if not loop.last %},{% endif %} {% endfor %} ] } {% endif %} }"
},
"httpMethod":"POST",
"contentType":"application/json",
"headers":[
{
"header":"Accept",
"value":{
"templatingStrategy":"NONE",
"value":"application/vnd.moviestar+json; version=3;"
}
}
]
},
"qos":{
"name":"freeform"
}
},
{
"instanceId":"d88de647-a352-4824-8b46-354afc7acbff",
"createdDate":"2020-11-17T16:50:59.635228Z",
"lastModifiedDate":"2020-11-17T16:50:59.635228Z",
"name":"Test11 Destination Server",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"https://go.{% if destination.config.domain == \"US\" %}moviestar.com{% else %}moviestar.eu{% endif%}/api/named_users/tags"
}
},
"httpTemplate":{
"requestBody":{
"templatingStrategy":"PEBBLE_V1",
"value":"{ \"audience\": { \"named_user_id\": [ {% for named_user in input.profile.identityMap.named_user_id %} \"{{ named_user.id }}\"{% if not loop.last %},{% endif %} {% endfor %} ] }, {% if addedSegments(input.profile.segmentMembership.ups) is not empty %} \"add\": { \"adobe-segments\": [ {% for added_segment in addedSegments(input.profile.segmentMembership.ups) %} \"{{ destination.segmentNames[added_segment.key] }}\"{% if not loop.last %},{% endif %} {% endfor %} ] } {% endif %} {% if addedSegments(input.profile.segmentMembership.ups) is not empty and removedSegments(input.profile.segmentMembership.ups) is not empty %} , {% endif %} {% if removedSegments(input.profile.segmentMembership.ups) is not empty %} \"remove\": { \"adobe-segments\": [ {% for removed_segment in removedSegments(input.profile.segmentMembership.ups) %} \"{{ destination.segmentNames[removed_segment.key] }}\"{% if not loop.last %},{% endif %} {% endfor %} ] } {% endif %} }"
},
"httpMethod":"POST",
"contentType":"application/json",
"headers":[
{
"header":"Accept",
"value":{
"templatingStrategy":"NONE",
"value":"application/vnd.moviestar+json; version=3;"
}
}
]
},
"qos":{
"name":"freeform"
}
}
]
}
La siguiente solicitud recupera una configuración específica del servidor de destino definida por el {INSTANCE_ID} parámetro.
El ID de la configuración del servidor de destino que desea recuperar.
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con la configuración del servidor de destino correspondiente a {INSTANCE_ID} ha proporcionado.
{
"items":[
{
"instanceId":"2307ec2b-4798-45a4-9239-5d0a2fb0ed67",
"createdDate":"2020-11-17T06:49:24.331012Z",
"lastModifiedDate":"2020-11-17T06:49:24.331012Z",
"name":"Moviestar Destination Server",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"https://go.{% if destination.config.domain == \"US\" %}moviestar.com{% else %}moviestar.eu{% endif%}/api/named_users/tags"
}
},
"httpTemplate":{
"requestBody":{
"templatingStrategy":"PEBBLE_V1",
"value":"{ \"audience\": { \"named_user_id\": [ {% for named_user in input.profile.identityMap.named_user_id %} \"{{ named_user.id }}\"{% if not loop.last %},{% endif %} {% endfor %} ] }, {% if addedSegments(input.profile.segmentMembership.ups) is not empty %} \"add\": { \"adobe-segments\": [ {% for added_segment in addedSegments(input.profile.segmentMembership.ups) %} \"{{ destination.segmentNames[added_segment.key] }}\"{% if not loop.last %},{% endif %} {% endfor %} ] } {% endif %} {% if addedSegments(input.profile.segmentMembership.ups) is not empty and removedSegments(input.profile.segmentMembership.ups) is not empty %} , {% endif %} {% if removedSegments(input.profile.segmentMembership.ups) is not empty %} \"remove\": { \"adobe-segments\": [ {% for removed_segment in removedSegments(input.profile.segmentMembership.ups) %} \"{{ destination.segmentNames[removed_segment.key] }}\"{% if not loop.last %},{% endif %} {% endfor %} ] } {% endif %} }"
},
"httpMethod":"POST",
"contentType":"application/json",
"headers":[
{
"header":"Accept",
"value":{
"templatingStrategy":"NONE",
"value":"application/vnd.moviestar+json; version=3;"
}
}
]
},
"qos":{
"name":"freeform"
}
}
]
}
Administración de errores de API
Los extremos de la API de Destination SDK siguen los principios generales del mensaje de error de la API de Experience Platform. Consulte Códigos de estado de API y errores de encabezado de solicitud en la guía de solución de problemas de Platform.
Pasos siguientes
Después de leer este documento, ahora sabe cómo recuperar una configuración de servidor de destino a través del Destination SDK /authoring/destination-servers Extremo de API.
Para obtener más información acerca de lo que puede hacer con este extremo, consulte los siguientes artículos:
