Documentación Experience Platform Guía de destinos

Recuperar una solicitud de publicación de destino

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Temas:
Destinos

Creado para:

Administrador
Usuario

IMPORTANT

Solo debe utilizar este punto final de API si envía un destino productizado (público) para que lo utilicen otros clientes de Experience Platform. Si está creando un destino privado para su propio uso, no necesita enviar formalmente el destino mediante la API de publicación.

IMPORTANT

extremo de API: platform.adobe.io/data/core/activation/authoring/destinations/publish

Después de configurar y probar el destino, puede enviarlo al Adobe para que lo revise y publique. Lea Enviar para revisión un destino creado en el Destination SDK para todos los demás pasos que debe realizar como parte del proceso de envío de destino.

Utilice el punto final de la API de destinos de publicación para enviar una solicitud de publicación cuando:

Como socio Destination SDK, desea que el destino de productos esté disponible en todas las organizaciones de Experience Platform para que lo utilicen todos los clientes Experience Platform;
Haces cualquier actualización a tus configuraciones. Las actualizaciones de configuración se reflejan en el destino solo después de enviar una nueva solicitud de publicación, que es aprobada por el equipo de Experience Platform.

IMPORTANT

Todos los nombres y valores de parámetro admitidos por el Destination SDK distinguen entre mayúsculas y minúsculas 1}. 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 de publicación de destino get-started

Antes de continuar, revisa la guía de introducción para obtener información importante que necesitas conocer para poder realizar llamadas a la API correctamente, incluyendo cómo obtener el permiso de creación de destino requerido y los encabezados requeridos.

Enumerar solicitudes de publicación de destino retrieve-list

Puede recuperar una lista de todos los destinos enviados para su publicación para su organización IMS realizando una solicitud de GET al extremo /authoring/destinations/publish.

Formato de API

Utilice el siguiente formato de API para recuperar todas las solicitudes de publicación de la cuenta.

GET /authoring/destinations/publish

Utilice el siguiente formato de API para recuperar una solicitud de publicación específica, definida por el parámetro {DESTINATION_ID}.

GET /authoring/destinations/publish/{DESTINATION_ID}

Solicitud

Las dos solicitudes siguientes recuperan todas las solicitudes de publicación de su organización de IMS o una solicitud de publicación específica, en función de si pasa el parámetro DESTINATION_ID en la solicitud.

Seleccione cada pestaña a continuación para ver la carga útil correspondiente.

Recuperar todas las solicitudes de publicación

accordion

Solicitud

La siguiente solicitud recuperará la lista de solicitudes de publicación que ha enviado, según la configuración de IMS Org ID y la zona protegida.

code language-shell

curl -X GET https://platform.adobe.io/data/core/activation/authoring/destinations/publish \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

accordion

Respuesta

La siguiente respuesta devuelve el estado HTTP 200 con una lista de todos los destinos enviados para la publicación a los que tiene acceso, en función del ID de organización de IMS y el nombre de la zona protegida que ha utilizado. Un(a) configId corresponde a la solicitud de publicación de un destino.

code language-json

{
   "destinationId":"1230e5e4-4ab8-4655-ae1e-a6296b30f2ec",
   "publishDetailsList":[
      {
         "configId":"ab41387c0-4772-4709-a3ce-6d5fee654520",
         "allowedOrgs":[
            "716543205DB85F7F0A495E5B@AdobeOrg"
         ],
         "status":"TEST",
         "destinationType":"DEV"
      },
      {
         "configId":"cd568c67-f25e-47e4-b9a2-d79297a20b27",
         "allowedOrgs":[
            "*"
         ],
         "status":"DEPRECATED",
         "destinationType":"PUBLIC",
         "publishedDate":1630525501009
      },
      {
         "configId":"ef6f07154-09bc-4bee-8baf-828ea9c92fba",
         "allowedOrgs":[
            "*"
         ],
         "status":"PUBLISHED",
         "destinationType":"PUBLIC",
         "publishedDate":1630531586002
      }
   ]
}

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 layout-auto
Parámetro	Tipo	Descripción
`destinationId`	Cadena	El ID de destino de la configuración de destino que ha enviado para su publicación.
`publishDetailsList.configId`	Cadena	El ID único de la solicitud de publicación de destino del destino enviado.
`publishDetailsList.allowedOrgs`	Cadena	Devuelve las organizaciones Experience Platform para las que está disponible el destino. Para `"destinationType": "PUBLIC"`, este parámetro devuelve `"*"`, lo que significa que el destino está disponible para todas las organizaciones de Experience Platform. Para `"destinationType": "DEV"`, este parámetro devuelve el identificador de organización de la organización que utilizó para crear y probar el destino.
`publishDetailsList.status`	Cadena	El estado de la solicitud de publicación de destino. Los valores posibles son `TEST`, `REVIEW`, `APPROVED`, `PUBLISHED`, `DENIED`, `REVOKED`, `DEPRECATED`. Los destinos con el valor `PUBLISHED` están activos y los clientes de Experience Platform los pueden usar.
`publishDetailsList.destinationType`	Cadena	El tipo de destino. Los valores pueden ser `DEV` y `PUBLIC`. `DEV` corresponde al destino en su organización Experience Platform. `PUBLIC` corresponde al destino que ha enviado para su publicación. Piense en estas dos opciones en términos de Git, donde la versión `DEV` representa su rama de creación local y la versión `PUBLIC` representa la rama principal remota.
`publishDetailsList.publishedDate`	Cadena	La fecha en la que se envió el destino para su publicación, en tiempo récord.

Recuperar una solicitud de publicación específica

accordion

Solicitud

code language-shell

curl -X GET https://platform.adobe.io/data/core/activation/authoring/destinations/publish/{DESTINATION_ID} \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

table 0-row-2 1-row-2
Parámetro	Descripción
`{DESTINATION_ID}`	El ID del destino para el que desea recuperar el estado de publicación.

accordion

Respuesta

Si pasó DESTINATION_ID en la llamada de API, la respuesta devuelve el estado HTTP 200 con información detallada sobre la solicitud de publicación de destino especificada.

code language-json

{
   "destinationId":"1230e5e4-4ab8-4655-ae1e-a6296b30f2ec",
   "publishDetailsList":[
      {
         "configId":"123cs780-ce29-434f-921e-4ed6ec2a6c35",
         "allowedOrgs": [
            "*"
         ],
         "status":"PUBLISHED",
         "destinationType": "PUBLIC",
         "publishedDate":"1630617746"
      }
   ]
}

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 layout-auto
Parámetro	Tipo	Descripción
`destinationId`	Cadena	El ID de destino de la configuración de destino que ha enviado para su publicación.
`publishDetailsList.configId`	Cadena	El ID único de la solicitud de publicación de destino del destino enviado.
`publishDetailsList.allowedOrgs`	Cadena	Devuelve las organizaciones Experience Platform para las que está disponible el destino. Para `"destinationType": "PUBLIC"`, este parámetro devuelve `"*"`, lo que significa que el destino está disponible para todas las organizaciones de Experience Platform. Para `"destinationType": "DEV"`, este parámetro devuelve el identificador de organización de la organización que utilizó para crear y probar el destino.
`publishDetailsList.status`	Cadena	El estado de la solicitud de publicación de destino. Los valores posibles son `TEST`, `REVIEW`, `APPROVED`, `PUBLISHED`, `DENIED`, `REVOKED`, `DEPRECATED`. Los destinos con el valor `PUBLISHED` están activos y los clientes de Experience Platform los pueden usar.
`publishDetailsList.destinationType`	Cadena	El tipo de destino. Los valores pueden ser `DEV` y `PUBLIC`. `DEV` corresponde al destino en su organización Experience Platform. `PUBLIC` corresponde al destino que ha enviado para su publicación. Piense en estas dos opciones en términos de Git, donde la versión `DEV` representa su rama de creación local y la versión `PUBLIC` representa la rama principal remota.
`publishDetailsList.publishedDate`	Cadena	La fecha en la que se envió el destino para su publicación, en tiempo récord.

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.

recommendation-more-help

7f4d1967-bf93-4dba-9789-bb6b505339d6