Checkouts

Subir una imagen del checkout

Sube una imagen a un slot del diseño. El nombre del campo es el slot, y va una imagen por request.

POST

/checkouts/{id}/images

curl --request POST \
  --url https://hub.grou.com/api/ext/checkouts/{id}/images \
  --header 'Authorization: Bearer <token>' \
  --form 'alt=<string>' \
  --form 'carousel=<string>' \
  --form 'index=123' \
  --form 'offer_footer=<string>' \
  --form 'offer_header=<string>' \
  --form 'offer_mid=<string>' \
  --form 'offer_side=<string>' \
  --form 'thumbnail=<string>'

{
  "media": {
    "alt": "<string>",
    "content_type": "<string>",
    "index": 123,
    "slot": "<string>",
    "type": "YOUTUBE",
    "url": "<string>",
    "youtube_id": "<string>"
  },
  "resource": {
    "checkout_url": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "external_ref": "<string>",
    "id": "<string>",
    "state": "draft",
    "type": "program",
    "updated_at": "2023-11-07T05:31:56Z",
    "version_id": "<string>"
  }
}

Una imagen por request; el nombre del campo es el slot.

# Miniatura (requerida para publicar)
curl -X POST https://hub.grou.com/api/ext/checkouts/$CHECKOUT_ID/images \
  -H "Authorization: Bearer $GROU_API_KEY" \
  -F "thumbnail=@./portada.png"

# Agregar una imagen al carrusel, con texto alternativo
curl -X POST https://hub.grou.com/api/ext/checkouts/$CHECKOUT_ID/images \
  -H "Authorization: Bearer $GROU_API_KEY" \
  -F "carousel=@./slide.png" \
  -F "alt=Vista del curso"

# Agregar un video de YouTube al carrusel
curl -X POST https://hub.grou.com/api/ext/checkouts/$CHECKOUT_ID/images \
  -H "Authorization: Bearer $GROU_API_KEY" \
  -F "carousel=https://youtu.be/dQw4w9WgXcQ"

Slot	Tipo
`thumbnail`	único (requerido para publicar)
`offer_header`, `offer_mid`, `offer_footer`	único
`offer_side`	lista, máx. 6
`carousel`	lista, máx. 10; acepta videos de YouTube

Slots únicos: reemplazan la imagen anterior y no aceptan index.
Slots de lista: sin index agrega al final; con index reemplaza esa posición.
Para un video en el carrusel, envía carousel como texto con el link de YouTube (o su id de 11 caracteres) en vez de un archivo.

Si el checkout está publicado, el cambio se ve al volver a publicar.

Autorizaciones

Authorizationstringheaderobligatorio

Tu API Key del Hub (Configuración → API Keys), que empieza por sk_. Solo se muestra una vez al generarla.

Parámetros de ruta

idstringobligatorio

El id del recurso, tal como lo devolvió la API.

Cuerpo

altstring

Texto alternativo / pie de imagen (opcional).

carouselstring

Un archivo de imagen, o un link de YouTube como texto.

indexinteger

Solo slots de lista. Posición a reemplazar; omítelo para agregar al final.

Rango requerido: 0 <= x

offer_footerstring

offer_headerstring

offer_midstring

offer_sidestring

thumbnailstring

Respuesta

Imagen guardada.

mediaobject

Mostrar child attributes

resourceobject

Mostrar child attributes

¿Aún necesitas ayuda? Comparte una idea