Skip to content

API Hub

Esta referência é de uma action do API Hub. Para mais informações, consulte a documentação do API Hub.


Esta é a referência da action @layers:data:Prepare.
Para responder a esta action, seu app deve implementar uma rota que receba uma requisição POST seguindo os seguintes formatos de requisição e resposta:

Requisição

Este é o formato da requisição que sua API deve receber.

uploadUrlstringObrigatório

URL para a qual devem ser enviadas as entidades de sincronização

syncProfileIdstringObrigatório

Identificador do perfíl de sincronização

Exemplo:b7e23ec2-8aaf-4c2b-9c1a-1e2f3d4b5c6d
syncRunIdstringObrigatório

Identificador da execução da sincronização

Exemplo:a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d
seasonstringObrigatório

Identificador do período ativo

Exemplo:2025-1
contextobjectObrigatório

Contexto da requisição

issuedAtstringdate-timeObrigatório

Data e hora de quando a requisição foi feita

Exemplo:2026-02-13T18:40:09.754Z
actionstringObrigatório

Identificador da action

Exemplo:@layers:data:Prepare
communitystringObrigatório

Identificador da comunidade

Exemplo:idcomunidadeteste
secretstring

Chave secreta específica do app

Exemplo:********************

Resposta

Este é o formato da resposta que sua API deve retornar.