Subir un activo a la biblioteca multimedia

Utiliza este punto final para añadir un activo a la biblioteca multimedia de Braze utilizando una URL alojada externamente (asset_url) o datos de archivos binarios enviados en el cuerpo de la solicitud (asset_file). Este punto final admite imágenes y archivos ZIP que contienen imágenes.

Requisitos previos

Para utilizar este punto final, necesitarás una clave de API con el permiso media_library.create.

Límite de velocidad

Aplicamos el límite de velocidad predeterminado de Braze de 250 000 solicitudes por hora a este punto final, como se documenta en Límites de velocidad de la API.

Cuerpo de la solicitud

Cuando incluyes asset_url, el punto final descarga el archivo desde la URL. Cuando incluyes asset_file, el punto final utiliza los datos binarios del cuerpo de la solicitud.

Ejemplo de cuerpo de solicitud paraasset_url:

1
2
3
4
{
  "asset_url": "https://cdn.example.com/assets/cat.jpg",
  "name": "Cat Graphic"
}

Ejemplo de cuerpo de solicitud paraasset_file:

1
2
3
4
{
  "asset_file": <BINARY FILE DATA>,
  "name": "Cat Graphic"
}

El cuerpo de la solicitud incluye los siguientes parámetros:

Nombres de los archivos subidos

En esta sección se explica cómo el punto final asigna nombres a los archivos cargados en función de si se incluye elnameparámetro .

Subidas de archivos individuales

Carga de archivos ZIP

Ejemplo de solicitud

Esta sección incluye dos ejemploscurlde solicitudes, una para añadir un activo utilizando una URL y otra utilizando datos de archivo binario.

Esta solicitud muestra un ejemplo de cómo añadir un activo a la biblioteca multimedia utilizando un asset_url.

1
2
3
4
curl -X POST --location 'https://rest.iad-01.braze.com/media_library/create' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--header 'Content-Type: application/json' \
--data '{"asset_url": "https://cdn.example.com/assets/cat.jpg", "name": "Cat Graphic"}'

Esta solicitud muestra un ejemplo de cómo añadir un activo a la biblioteca multimedia utilizando un asset_file.

1
2
3
4
curl -X POST --location 'https://rest.iad-01.braze.com/media_library/create' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--header 'Content-Type: application/json' \
--data '{"asset_file":<BINARY FILE DATA>, "name":"Cat Graphic"}'

Respuestas de error

En esta sección se enumeran los posibles errores y sus correspondientes mensajes y descripciones.

Errores de validación

Los errores de validación devuelven una estructura como esta:

1
2
3
{
  "message": (String) Human-readable error description
}

Esta tabla enumera los posibles errores de validación.

Errores de procesamiento

Los errores de procesamiento devuelven una respuesta diferente con códigos de error:

1
2
3
4
5
{
  "message": (String) Human-readable error description,
  "error_code": (String) error code,
  "meta": { }
}

Esta tabla enumera los posibles errores de procesamiento.

Respuesta

Hay cinco respuestas de código de estado para este punto final: 200, 400,403 429, y 500.

El siguiente JSON muestra el formato esperado de la respuesta.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{ 
    "new_assets": [
        {
            "name": (String) the name of the asset,
            "size": (Integer) the byte size of the asset,
            "url": (String) the URL to access the asset,
            "ext": (String) the file extension (e.g., "png", "jpg", "gif")
        }
    ],
    "errors": [
        {
            "name": (String) the name of the asset,
            "size": (Integer) the byte size of the asset,
            "ext": (String) the file extension (e.g., "png", "jpg", "gif"),
            "error": (String) the error that occurred
        }
    ],
    "dashboard_url": (String) the URL to view this asset in the Braze dashboard
}