API atual/Referência completa/Sessões ao vivo

POSTClipes da reprise

Anexa um trecho da gravação da sessão à galeria de vídeos de um produto.

Um clipe é um trecho da gravação da sessão que aparece na galeria de vídeos de um produto, para o cliente ver o produto sendo apresentado. A sessão precisa estar ended e ter replay_url. O clipe conta no limite de 3 vídeos por produto.

POST/api/v1/admin/live-sessions/{id}/clipsAdmin

Anexa um trecho da reprise a um produto

Exige o privilégio manage_catalog. Esta rota fica no grupo do catálogo.

Parâmetros de caminho

iduuidobrigatório

Identificador da sessão.

Corpo da requisição

product_iduuidobrigatório

Produto que recebe o clipe.

start_sintegerobrigatório

Segundo em que o trecho começa (0 ou mais).

end_sintegerobrigatório

Segundo em que o trecho termina. Precisa ser maior que start_s.

thumbnail_urlstringobrigatório

Imagem de capa do clipe. Obrigatória: a plataforma não gera.

titlestring

Título do clipe.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/live-sessions/7ec34d19-64f7-4d36-92eb-dbb217448af7/clips" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "product_id": "7bc1d5e9-a9a4-457b-866f-bbb3879d258d",
  "start_s": 600,
  "end_s": 660,
  "title": "Apresentação da camiseta",
  "thumbnail_url": "https://cdn.minhaloja.com.br/clips/camiseta.jpg"
}'

Resposta

201Clipe criado

json

{
  "id": "3d7a5b1e-9f2c-4c58-8f11-2a6b0c1d7e90",
  "product_id": "7bc1d5e9-a9a4-457b-866f-bbb3879d258d",
  "video_type": "live_clip",
  "url": "https://www.youtube.com/watch?v=replay456",
  "thumbnail_url": "https://cdn.minhaloja.com.br/clips/camiseta.jpg",
  "title": "Apresentação da camiseta",
  "position": 0,
  "live_session_id": "7ec34d19-64f7-4d36-92eb-dbb217448af7",
  "clip_start_s": 600,
  "clip_end_s": 660
}

Campos da resposta

iduuid

Identificador do vídeo.

product_iduuid

Produto.

video_typestring

Sempre live_clip aqui.

urlstring

Endereço da gravação (o replay_url da sessão).

thumbnail_urlstring

Capa.

titlestring

Título.

positioninteger

Posição na galeria de vídeos do produto.

live_session_iduuid

Sessão de origem.

clip_start_sinteger

Início do trecho, em segundos.

clip_end_sinteger

Fim do trecho, em segundos.

Erros

Status	Quando	Exemplo de corpo
401	Token ausente, inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O administrador não tem o privilégio exigido.	`{"error":"insufficient privileges","required":"manage_catalog"}`
404	Produto inexistente.	`{"error":"product not found"}`
422	A sessão não está `ended` ou não tem `replay_url`; intervalo de segundos inválido; sem `thumbnail_url`; produto já com 3 vídeos.	`{"error":"invalid live clip","detail":"session has no replay"}`

Veja também

POSTClipes da reprise

Anexa um trecho da gravação da sessão à galeria de vídeos de um produto.

POST/api/v1/admin/live-sessions/{id}/clipsAdmin

Anexa um trecho da reprise a um produto

Exige o privilégio manage_catalog. Esta rota fica no grupo do catálogo.

Parâmetros de caminho

iduuidobrigatório

Identificador da sessão.

Corpo da requisição

product_iduuidobrigatório

Produto que recebe o clipe.

start_sintegerobrigatório

Segundo em que o trecho começa (0 ou mais).

end_sintegerobrigatório

Segundo em que o trecho termina. Precisa ser maior que start_s.

thumbnail_urlstringobrigatório

Imagem de capa do clipe. Obrigatória: a plataforma não gera.

titlestring

Título do clipe.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/live-sessions/7ec34d19-64f7-4d36-92eb-dbb217448af7/clips" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "product_id": "7bc1d5e9-a9a4-457b-866f-bbb3879d258d",
  "start_s": 600,
  "end_s": 660,
  "title": "Apresentação da camiseta",
  "thumbnail_url": "https://cdn.minhaloja.com.br/clips/camiseta.jpg"
}'

Resposta

201Clipe criado

json

{
  "id": "3d7a5b1e-9f2c-4c58-8f11-2a6b0c1d7e90",
  "product_id": "7bc1d5e9-a9a4-457b-866f-bbb3879d258d",
  "video_type": "live_clip",
  "url": "https://www.youtube.com/watch?v=replay456",
  "thumbnail_url": "https://cdn.minhaloja.com.br/clips/camiseta.jpg",
  "title": "Apresentação da camiseta",
  "position": 0,
  "live_session_id": "7ec34d19-64f7-4d36-92eb-dbb217448af7",
  "clip_start_s": 600,
  "clip_end_s": 660
}

Campos da resposta

iduuid

Identificador do vídeo.

product_iduuid

Produto.

video_typestring

Sempre live_clip aqui.

urlstring

Endereço da gravação (o replay_url da sessão).

thumbnail_urlstring

Capa.

titlestring

Título.

positioninteger

Posição na galeria de vídeos do produto.

live_session_iduuid

Sessão de origem.

clip_start_sinteger

Início do trecho, em segundos.

clip_end_sinteger

Fim do trecho, em segundos.

Erros

Status	Quando	Exemplo de corpo
401	Token ausente, inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O administrador não tem o privilégio exigido.	`{"error":"insufficient privileges","required":"manage_catalog"}`
404	Produto inexistente.	`{"error":"product not found"}`
422	A sessão não está `ended` ou não tem `replay_url`; intervalo de segundos inválido; sem `thumbnail_url`; produto já com 3 vídeos.	`{"error":"invalid live clip","detail":"session has no replay"}`