VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Engajamento e conteúdo

Seis áreas pequenas do painel de administração que ligam a loja a anunciantes, ao app mobile, a formulários públicos e ao RD Station Marketing.

Esta seção reúne áreas de engajamento que não têm seção própria: a publicidade patrocinada do marketplace, as páginas do app mobile, as respostas dos formulários que o público preenche, a integração com o RD Station Marketing (automação de marketing) e duas rotas de compatibilidade que existem só por contrato.

Pontos-chave
  • Quase tudo aqui depende de um módulo ligado na loja: mobile-pages para páginas do app, rd-station-marketing para o RD Station. Com o módulo desligado a resposta é 403 com {"error":"module_disabled","module":"..."}.
  • Dinheiro de publicidade é inteiro em centavos (floor_price_cents: 20 são R$ 0,20).
  • A publicidade tem relatório global de toda a loja; as campanhas em si são dos sellers e ficam na API do seller.
  • As respostas de formulário (form-submissions) são lidas e movidas por status; quem recebe a resposta nasce no formulário público, não nesta API.
  • GET /app-banners e GET /notifications do administrador são rotas de compatibilidade que sempre devolvem lista vazia.

Como funciona

Publicidade patrocinada

O seller cria campanhas e as paga com uma carteira de créditos. A loja liga ou desliga a publicidade e define o piso do leilão. Quando a vitrine pede espaços patrocinados, a plataforma roda um leilão de segundo preço: o vencedor paga o lance do segundo colocado, nunca menos que o piso. O administrador tem três rotas: ler e alterar a configuração e consultar o relatório (Publicidade).

Resposta de formulário

Visitante envia→new→read→replied
statusSignificado
newRecebida, ninguém olhou.
readAlguém da equipe abriu.
repliedA equipe já respondeu.

Conceitos-chave

Módulos

Um módulo é um recurso que cada loja liga ou desliga. A plataforma bloqueia as rotas do módulo desligado com 403 module_disabled.

Privilégios

Cada rota exige um privilégio do grupo do administrador. Em geral: conteúdo (páginas do app, formulários) usa view_content para ler e manage_content para escrever; o RD Station exige manage_settings.

Identificadores e datas

Todos os ids novos são UUID em string. Datas em RFC 3339, UTC.

Endpoints

Método e caminhoPara que serveAutenticaçãoPágina
GET /api/v1/admin/ads/settingsLê a configuração de anúnciosadministradorPublicidade
PUT /api/v1/admin/ads/settingsAltera a configuraçãoadministradorPublicidade
GET /api/v1/admin/ads/reportTotais da lojaadministradorPublicidade
GET /api/v1/admin/mobile-pagesLista páginas do appadministradorPáginas do app
POST /api/v1/admin/mobile-pagesCria páginaadministradorPáginas do app
PUT /api/v1/admin/mobile-pages/{id}Altera páginaadministradorPáginas do app
DELETE /api/v1/admin/mobile-pages/{id}Apaga páginaadministradorPáginas do app
GET /api/v1/admin/form-submissions/{id}Lê uma respostaadministradorRespostas de formulário
PATCH /api/v1/admin/form-submissions/{id}/statusMuda o statusadministradorRespostas de formulário
DELETE /api/v1/admin/form-submissions/{id}Apaga a respostaadministradorRespostas de formulário
GET /api/v1/admin/rd-station/statusEstado da integraçãoadministradorRD Station
POST /api/v1/admin/rd-station/test-connectionTesta as credenciaisadministradorRD Station
POST /api/v1/admin/rd-station/test-eventEnvia evento de testeadministradorRD Station
POST /api/v1/admin/rd-station/clear-cacheLimpa os tokens em cacheadministradorRD Station
POST /api/v1/admin/rd-station/abandoned-runRoda a varredura de carrinhosadministradorRD Station
GET /api/v1/admin/rd-station/logsLê o log da integraçãoadministradorRD Station
GET /api/v1/admin/app-bannersCompatibilidade, sempre vaziaadministradorRotas de compatibilidade
GET /api/v1/admin/notificationsCompatibilidade, sempre vaziaadministradorRotas de compatibilidade

Erros comuns

  • Chamar uma rota de módulo desligado. 403 module_disabled. Peça a ativação do módulo antes de integrar.
  • Mandar PUT /ads/settings incompleto. O corpo substitui a configuração inteira; campos omitidos são gravados como falso, zero ou vazio (veja a página de publicidade).
  • Esperar páginas inativas na lista do app. Só aparecem páginas ativas.
  • Achar que PUT /mobile-pages/{id} grava seções. Só os campos da página são gravados.
  • Usar status fora de new, read, replied nas respostas de formulário. É 400 INVALID_STATUS.
  • Tratar o 200 do teste de conexão do RD Station como sucesso. Leia ok no corpo.

Próximos passos

Publicidade
Ligar anúncios e ver os totais.
RD Station
Testar e operar a integração.
Respostas de formulário
Triar o que o público enviou.
Anterior
Log de entrega
Próxima
Publicidade patrocinada
Nesta página
  • Como funciona
  • Publicidade patrocinada
  • Resposta de formulário
  • Conceitos-chave
  • Módulos
  • Privilégios
  • Identificadores e datas
  • Endpoints
  • Erros comuns
  • Próximos passos