Adobe Experience Manager Assets API HTTP

Información general

La variable Assets La API HTTP permite crear, leer, actualizar y eliminar operaciones (CRUD) en recursos digitales, incluidos metadatos, representaciones y comentarios, junto con contenido estructurado mediante Experience Manager Fragmentos de contenido. Está expuesto en /api/assets y se implementa como API de REST. Incluye compatibilidad con fragmentos de contenido.

Para acceder a la API:

  1. Abra el documento del servicio API en https://[hostname]:[port]/api.json.
  2. Siga las Assets vínculo de servicio que lleva a https://[hostname]:[server]/api/assets.json.

La respuesta de API es un archivo JSON para algunos tipos MIME y un código de respuesta para todos los tipos MIME. La respuesta JSON es opcional y es posible que no esté disponible, por ejemplo para archivos PDF. Confíe en el código de respuesta para realizar más análisis o acciones.

NOTA

Todas las llamadas a la API relacionadas con la carga o actualización de recursos o binarios en general (como las representaciones) quedan obsoletas para Experience Manager como Cloud Service implementación. Para cargar binarios, utilice API de carga binaria directa en su lugar.

Fragmentos de contenido

A Fragmento de contenido es un tipo especial de recurso. Se puede utilizar para acceder a datos estructurados, como textos, números, fechas, entre otros. Como hay varias diferencias con standard recursos (como imágenes o documentos), algunas reglas adicionales se aplican a la gestión de fragmentos de contenido.

Para obtener más información, consulte Compatibilidad con fragmentos de contenido en la sección Experience Manager Assets API HTTP.

modelo Data

La variable Assets La API HTTP expone dos elementos principales, carpetas y recursos (para recursos estándar). Además, expone elementos más detallados para los modelos de datos personalizados que describen contenido estructurado en fragmentos de contenido. Consulte Modelos de datos de fragmento de contenido para obtener más información.

Carpetas

Las carpetas son como directorios, como en los sistemas de archivos tradicionales. La carpeta solo puede contener recursos, solo carpetas, o carpetas y recursos. Las carpetas tienen los siguientes componentes:

Entidades: Las entidades de una carpeta son sus elementos secundarios, que pueden ser carpetas y recursos.

Propiedades:

  • name es el nombre de la carpeta. Es el mismo que el último segmento de la ruta URL sin la extensión.
  • title es un título opcional de la carpeta que se puede mostrar en lugar de su nombre.
NOTA

Algunas propiedades de carpeta o recurso se asignan a un prefijo diferente. La variable jcr prefijo de jcr:title, jcr:descriptiony jcr:language se sustituyen por dc prefijo . Por lo tanto, en el JSON devuelto, dc:title y dc:description contiene los valores de jcr:title y jcr:description, respectivamente.

Vínculos Las carpetas exponen tres vínculos:

  • self: Vínculo a sí mismo.
  • parent: Enlace a la carpeta principal.
  • thumbnail: (Opcional) vínculo a una imagen en miniatura de la carpeta.

Assets

En Experience Manager un recurso contiene los siguientes elementos:

  • Propiedades y metadatos del recurso.
  • Archivo binario cargado originalmente del recurso.
  • Varias representaciones tal y como están configuradas. Pueden ser imágenes de diferentes tamaños, vídeos de diferentes codificaciones o páginas extraídas del PDF o Adobe InDesign archivos.
  • Comentarios opcionales.

Para obtener información sobre los elementos de los fragmentos de contenido, consulte Compatibilidad con fragmentos de contenido en la API HTTP de Experience Manager Assets.

En Experience Manager una carpeta tiene los siguientes componentes:

  • Entidades: Los elementos secundarios de los activos son sus representaciones.
  • Propiedades.
  • Vínculos.

Funciones disponibles

La variable Assets La API HTTP incluye las siguientes funciones:

NOTA

Para facilitar la lectura, en los ejemplos siguientes se omiten todas las notaciones cURL. La notación se correlaciona con Resty que es un envoltorio de secuencias de comandos para cURL.

Recuperar una lista de carpetas

Recupera una representación sirena de una carpeta existente y de sus entidades secundarias (subcarpetas o recursos).

Solicitud: GET /api/assets/myFolder.json

Códigos de respuesta: Los códigos de respuesta son:

  • 200 - OK - éxito.
  • 404 - NO ENCONTRADO - la carpeta no existe o no es accesible.
  • 500 - ERROR INTERNO DEL SERVIDOR - si algo más sale mal.

Respuesta: La clase de la entidad devuelta es un recurso o una carpeta. Las propiedades de las entidades contenidas son un subconjunto del conjunto completo de propiedades de cada entidad. Para obtener una representación completa de la entidad, los clientes deben recuperar el contenido de la URL señalada por el vínculo con una rel de self.

Cree una carpeta .

Crea un sling: OrderedFolder en la ruta dada. If * se proporciona en lugar de un nombre de nodo, el servlet utiliza el nombre del parámetro como nombre de nodo. La solicitud acepta cualquiera de las siguientes opciones:

  • Una representación sirena de la nueva carpeta
  • Conjunto de pares de nombre-valor codificados como application/www-form-urlencoded o multipart/ form- data. Son útiles para crear una carpeta directamente desde un formulario de HTML.

Además, las propiedades de la carpeta se pueden especificar como parámetros de consulta de URL.

Una llamada de API falla con una 500 código de respuesta si el nodo principal de la ruta proporcionada no existe. Una llamada devuelve un código de respuesta 409 si la carpeta existe.

Parámetros: name es el nombre de la carpeta.

Solicitar

  • POST /api/assets/myFolder -H"Content-Type: application/json" -d '{"class":"assetFolder","properties":{"title":"My Folder"}}'
  • POST /api/assets/* -F"name=myfolder" -F"title=My Folder"

Códigos de respuesta: Los códigos de respuesta son:

  • 201 - CREADO - sobre la creación correcta.
  • 409 - CONFLICTO - si existe la carpeta.
  • 412 - PRECONDICIÓN FALLIDA - si no se puede encontrar o acceder a la colección raíz.
  • 500 - ERROR INTERNO DEL SERVIDOR - si algo más sale mal.

Crear un recurso

Consulte carga de recursos para obtener información sobre cómo crear un recurso. No puede crear un recurso mediante la API HTTP.

Actualizar un binario de recursos

Consulte carga de recursos para obtener información sobre cómo actualizar los binarios de recursos. No puede actualizar un binario de recursos mediante la API HTTP.

Actualizar metadatos de un recurso

Actualiza las propiedades de metadatos de Asset. Si actualiza cualquier propiedad de la variable dc: espacio de nombres, la API actualiza la misma propiedad en la variable jcr espacio de nombres. La API no sincroniza las propiedades de las dos áreas de nombres.

Solicitud: PUT /api/assets/myfolder/myAsset.png -H"Content-Type: application/json" -d '{"class":"asset", "properties":{"dc:title":"My Asset"}}'

Códigos de respuesta: Los códigos de respuesta son:

  • 200 - Correcto: si el recurso se ha actualizado correctamente.
  • 404 - NO ENCONTRADO - si no se pudo encontrar o acceder al recurso en el URI proporcionado.
  • 412 - PRECONDICIÓN FALLIDA - si no se puede encontrar o acceder a la colección raíz.
  • 500 - ERROR INTERNO DEL SERVIDOR - si algo más sale mal.

Crear una representación de recursos

Cree una representación para un recurso. Si no se proporciona el nombre del parámetro de solicitud, el nombre del archivo se utiliza como nombre de representación.

Parámetros: Los parámetros son name para el nombre de la representación y file como referencia de archivo.

Solicitar

  • POST /api/assets/myfolder/myasset.png/renditions/web-rendition -H"Content-Type: image/png" --data-binary "@myRendition.png"
  • POST /api/assets/myfolder/myasset.png/renditions/* -F"name=web-rendition" -F"file=@myRendition.png"

Códigos de respuesta

  • 201 - CREADO - si la representación se ha creado correctamente.
  • 404 - NO ENCONTRADO - si no se pudo encontrar o acceder al recurso en el URI proporcionado.
  • 412 - PRECONDICIÓN FALLIDA - si no se puede encontrar o acceder a la colección raíz.
  • 500 - ERROR INTERNO DEL SERVIDOR - si algo más sale mal.

Actualizar una representación de recursos

Las actualizaciones reemplazan respectivamente una representación de recursos con los nuevos datos binarios.

Solicitud: PUT /api/assets/myfolder/myasset.png/renditions/myRendition.png -H"Content-Type: image/png" --data-binary @myRendition.png

Códigos de respuesta: Los códigos de respuesta son:

  • 200 - Correcto: si la representación se ha actualizado correctamente.
  • 404 - NO ENCONTRADO - si no se pudo encontrar o acceder al recurso en el URI proporcionado.
  • 412 - PRECONDICIÓN FALLIDA - si no se puede encontrar o acceder a la colección raíz.
  • 500 - ERROR INTERNO DEL SERVIDOR - si algo más sale mal.

Añadir un comentario en un recurso

Parámetros: Los parámetros son message para el cuerpo del mensaje del comentario y annotationData para los datos de anotación en formato JSON.

Solicitud: POST /api/assets/myfolder/myasset.png/comments/* -F"message=Hello World." -F"annotationData={}"

Códigos de respuesta: Los códigos de respuesta son:

  • 201 - CREADO - si Comment se ha creado correctamente.
  • 404 - NO ENCONTRADO - si no se pudo encontrar o acceder al recurso en el URI proporcionado.
  • 412 - PRECONDICIÓN FALLIDA - si no se puede encontrar o acceder a la colección raíz.
  • 500 - ERROR INTERNO DEL SERVIDOR - si algo más sale mal.

Copiar una carpeta o un recurso

Copia una carpeta o un recurso disponible en la ruta de acceso proporcionada a un nuevo destino.

Solicitar encabezados: Los parámetros son:

  • X-Destination : un nuevo URI de destino dentro del ámbito de la solución de API al que copiar el recurso.
  • X-Depth - o infinity o 0. Uso 0 solo copia el recurso y sus propiedades y no sus elementos secundarios.
  • X-Overwrite - Uso F para evitar sobrescribir un recurso en el destino existente.

Solicitud: COPY /api/assets/myFolder -H"X-Destination: /api/assets/myFolder-copy"

Códigos de respuesta: Los códigos de respuesta son:

  • 201 - CREADO - si la carpeta o el recurso se ha copiado en un destino no existente.
  • 204 - SIN CONTENIDO - si la carpeta o el recurso se ha copiado en un destino existente.
  • 412 - PRECONDITION ERROR - si falta un encabezado de solicitud.
  • 500 - ERROR INTERNO DEL SERVIDOR - si algo más sale mal.

Mover una carpeta o un recurso

Mueve una carpeta o un recurso en la ruta dada a un nuevo destino.

Solicitar encabezados: Los parámetros son:

  • X-Destination : un nuevo URI de destino dentro del ámbito de la solución de API al que copiar el recurso.
  • X-Depth - o infinity o 0. Uso 0 solo copia el recurso y sus propiedades y no sus elementos secundarios.
  • X-Overwrite - Utilice T para eliminar por la fuerza un recurso existente o F para evitar sobrescribir un recurso existente.

Solicitud: MOVE /api/assets/myFolder -H"X-Destination: /api/assets/myFolder-moved"

Códigos de respuesta: Los códigos de respuesta son:

  • 201 - CREADO - si la carpeta o el recurso se ha copiado en un destino no existente.
  • 204 - SIN CONTENIDO - si la carpeta o el recurso se ha copiado en un destino existente.
  • 412 - PRECONDITION ERROR - si falta un encabezado de solicitud.
  • 500 - ERROR INTERNO DEL SERVIDOR - si algo más sale mal.

Eliminar una carpeta, un recurso o una representación

Elimina un recurso (-tree) en la ruta proporcionada.

Solicitar

  • DELETE /api/assets/myFolder
  • DELETE /api/assets/myFolder/myAsset.png
  • DELETE /api/assets/myFolder/myAsset.png/renditions/original

Códigos de respuesta: Los códigos de respuesta son:

  • 200 - OK - si la carpeta se ha eliminado correctamente.
  • 412 - PRECONDICIÓN FALLIDA - si no se puede encontrar o acceder a la colección raíz.
  • 500 - ERROR INTERNO DEL SERVIDOR - si algo más sale mal.

Sugerencias, prácticas recomendadas y limitaciones

  • Después de la Tiempo de inactividad, un recurso y sus representaciones no están disponibles a través de la variable Assets interfaz web y a través de la API HTTP. La API devuelve el mensaje de error 404 si la variable Tiempo de activación está en el futuro o Tiempo de inactividad es en el pasado.

  • La API HTTP de recursos no devuelve los metadatos completos. Las áreas de nombres están codificadas y solo se devuelven esas áreas de nombres. Para ver los metadatos completos, consulte la ruta del recurso /jcr_content/metadata.json.

  • Algunas propiedades de la carpeta o del recurso se asignan a un prefijo diferente al actualizarse mediante API. La variable jcr prefijo de jcr:title, jcr:descriptiony jcr:language se sustituyen por dc prefijo . Por lo tanto, en el JSON devuelto, dc:title y dc:description contiene los valores de jcr:title y jcr:description, respectivamente.

En esta página