Skip to main content

​
Visão geral

A Solomon acompanha o desempenho de campanhas com influenciadores cruzando links rastreáveis e cupons com os pedidos da loja, e atribuindo os custos de comissão a cada influenciador. Tudo isso pode ser cadastrado e mantido pela API.
As rotas de influenciadores exigem os escopos influencers.read (leitura) e influencers.write (escrita) na sua API Key.

​
Modelo

  • Influenciador — identificado pelo name. É o nível mais alto; sobrevive mesmo sem campanhas.
  • Campanha (campaign_id) — agrupa links, cupons e custos de uma ação. Gerada automaticamente quando você não informa uma.
  • Link (short_code) — uma URL de destino que a Solomon encurta (short_url) e instrumenta com UTMs (utm_source=Influenciador, utm_campaign=<nome>, utm_content=<campanha>).
  • Cupom — código de desconto com período de validade, atribuído à campanha.
  • Custo — comissão fixa (R),comissa~ovariaˊvel(), comissão variável (%) e/ou valor por entrega (R) do influenciador.

​
Cadastro em uma requisição

O cadastro de influenciador (POST /influencers) cria tudo de uma vez — links, cupons e custos:
A resposta traz as URLs curtas geradas para cada link.
As URLs de destino passam por validação de segurança: apenas HTTPS, sem credenciais embutidas e apontando para um host público (bloqueia endereços internos/privados). URLs inválidas retornam 400 com a lista de erros.

​
Custos: comissão vs. valor

Cada custo em costs combina até três componentes (ao menos um diferente de zero):
  • fixed_fee — comissão fixa em R$
  • var_fee — comissão variável em %
  • value — valor por entrega em R$
is_campaign_cost define se o custo é da campanha (exige campaign_id) ou do influenciador; is_coupon_cost define a atribuição (cupom ou cupom_link).
Custos com value maior que zero entram também nos custos de marketing da loja (como influenciador) e exigem frequency. Custos só de comissão (fixed_fee/var_fee) não precisam de frequency.
Você pode gerir custos separadamente pelos endpoints adicionar custos (POST /influencers/costs, em lote por influenciador) e remover custo (DELETE /influencers/costs). Custos de comissão com períodos sobrepostos para o mesmo influenciador são rejeitados.

​
Cupons

Além de enviá-los no cadastro, cupons podem ser geridos por adicionar cupons (POST /influencers/coupons) e remover cupom (DELETE /influencers/coupons). Cupons com o mesmo código e período sobreposto são rejeitados com 409.

​
Exclusão granular

O DELETE de influenciadores (DELETE /influencers) tem três comportamentos:
  • Com short_code → remove apenas aquele link.
  • Sem short_code, com campaign_id → remove a campanha (links, cupons e custos de campanha). O influenciador continua cadastrado.
  • Com delete_influencer: true → remove o influenciador inteiro (todos os custos por nome + o cadastro).
A resposta é 200 quando tudo é removido, ou 207 quando alguma operação falha (o corpo detalha cada operação).

​
Leitura