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:payments:Tabs:getRelated.
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.

userobjectObrigatório
idstringObrigatório

Identificador do usuário

namestring

Nome do usuário

Exemplo:Carlos Pereira
aliasstring

Identificador do usuário na comunidade

Exemplo:user2
timezonestring

Fuso horário do usuário

Exemplo:America/Sao_Paulo
languagestring

Língua do usuário

Exemplo:pt-BR
accountIdstringObrigatório

Identificador da conta do usuário

emailstring

Email do usuário

Exemplo:carlos.pereira@gmail.com
channelsarrayObrigatório

Lista de canais de venda que o usuário está acessando

items
idstringObrigatório

Identificador do canal de venda

slugstringObrigatório
metadataobject

Metadados

contextobjectObrigatório

Contexto da requisição

issuedAtstringdate-timeObrigatório

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

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

Identificador da action

Exemplo:@layers:payments:Tabs:getRelated
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.

catalogTabsarrayObrigatório
items
aliasstringObrigatório

Identificador único da aba

titlestringObrigatório

Título da aba

channelIdstringObrigatório

Identificador do canal de venda

metadataobject

Dados adicionais do item