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

Chaves de recursos

Lê e liga ou desliga as chaves de recursos da loja, como lista de desejos, blog e modo multi-seller.

As feature flags são interruptores por loja. Cada chave liga ou desliga um recurso inteiro: com a chave desligada, as rotas daquele recurso deixam de funcionar para a loja. Ambas as rotas exigem especificamente o privilégio manage_settings.

Ler as chaves

GET/api/v1/admin/feature-flagsAdmin

Estado de todas as chaves

Exemplo de requisição

Resposta

200Chaves

Campos da resposta

wishlistsboolean
Lista de desejos da vitrine.
bestsellersboolean
Recurso de mais vendidos.
bannersboolean
Banners promocionais.
seoboolean
Recursos de SEO.
promotionsboolean
Motor de promoções.
multi_vendorboolean
Obsoleta. Foi substituída pela configuração de cadastro de sellers e é mantida só para dados já gravados.
blogboolean
Blog da loja.
newsletterboolean
Recurso de newsletter.
live_chatboolean
Chat ao vivo.
order_audit_logboolean
Auditoria de alterações em pedidos.
categories_by_vendorboolean
Cada seller tem suas próprias categorias. Padrão: false.
product_premoderationboolean
Moderação: produtos de sellers passam por aprovação do admin antes de ir ao ar. Padrão: true.
product_premoderation_updatesboolean
Estende a moderação às edições de produtos que já estão no ar. Só tem efeito com product_premoderation ligada. Padrão: true; ausente na resposta enquanto ninguém decidiu explicitamente.
vendor_debt_payoutboolean
Recurso de pagamento de débitos de sellers. Padrão: false.
vendor_categories_feeboolean
Taxa por categoria do seller. Padrão: false.
master_productsboolean
Produtos master. Padrão: false.
realtime_order_notifyboolean
Notificação de pedido em tempo real. Padrão: true.
master_products_list_masters_onlyboolean
Somente leitura aqui: com produtos mestre ligados, a vitrine lista só o cartão do mestre, não cada oferta. Aparece apenas quando é true e não pode ser alterado por esta rota.
soft_delete / field_masking / cdn_supportboolean
Aposentadas. Continuam aparecendo na leitura, mas não fazem nada e não podem mais ser alteradas.

Erros

StatusQuandoExemplo de corpo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403O token não é de um usuário administrador.{"error":"admin access required"}
403O usuário é administrador, mas não tem o privilégio exigido.{"error":"insufficient privileges","privilege_required_any":["manage_settings"]}
500Falha ao ler.{"error":"failed to get features","detail":"..."}

Alterar uma chave

PATCH/api/v1/admin/feature-flags/{key}Admin

Liga ou desliga uma chave

Parâmetros de caminho

keystringobrigatório
wishlistsbestsellersbannersseopromotionsmulti_vendorblognewsletterlive_chatorder_audit_logcategories_by_vendorproduct_premoderationproduct_premoderation_updatesvendor_debt_payoutvendor_categories_feemaster_productsrealtime_order_notify
Nome da chave, como aparece na leitura. As aposentadas não são aceitas.

Corpo da requisição

enabledbooleanobrigatório
true liga, false desliga. Se omitido vale false: a chave é desligada.

Exemplo de requisição

Resposta

200Chaves atualizadas

O corpo é o conjunto completo de chaves depois da mudança, no mesmo formato da leitura.

Erros

StatusQuandoExemplo de corpo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403O token não é de um usuário administrador.{"error":"admin access required"}
403O usuário é administrador, mas não tem o privilégio exigido.{"error":"insufficient privileges","privilege_required_any":["manage_settings"]}
400Chave desconhecida, ou corpo inválido.{"error":"unknown feature key","detail":"bloggg"}
410Chave aposentada (soft_delete, field_masking, cdn_support). Nada é gravado.{"error":"feature flag deprecated","detail":"soft_delete"}
500Falha ao gravar.{"error":"failed to update feature","detail":"..."}
Efeito imediato e auditado

A mudança vale na hora (o cache de chaves é invalidado) e fica no registro de atividades como settings + feature_flag_enabled ou feature_flag_disabled.

A gravação reescreve todas as chaves

A plataforma lê o conjunto de chaves, muda a sua e regrava tudo. Duas chamadas simultâneas para chaves diferentes podem se sobrescrever; faça uma por vez.

Veja também

  • Recursos nativos
  • Registro de atividades
Anterior
Recursos e métricas
Próxima
Recursos nativos
Nesta página
  • Ler as chaves
  • Exemplo de requisição
  • Resposta
  • Erros
  • Alterar uma chave
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também
bash
curl "$BASE_URL/api/v1/admin/feature-flags" \
  -H "Authorization: Bearer $TOKEN"
bash
curl -X PATCH "$BASE_URL/api/v1/admin/feature-flags/blog" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"enabled": true}'
json
{
  "wishlists": true,
  "bestsellers": false,
  "banners": true,
  "seo": true,
  "promotions": true,
  "multi_vendor": true,
  "blog": false,
  "newsletter": false,
  "live_chat": false,
  "order_audit_log": false,
  "soft_delete": false,
  "field_masking": false,
  "cdn_support": false,
  "categories_by_vendor": true,
  "product_premoderation": true,
  "vendor_debt_payout": false,
  "vendor_categories_fee": false,
  "master_products": true,
  "realtime_order_notify": true
}
json
{
  "wishlists": true,
  "bestsellers": false,
  "banners": true,
  "seo": true,
  "promotions": true,
  "multi_vendor": true,
  "blog": false,
  "newsletter": false,
  "live_chat": false,
  "order_audit_log": false,
  "soft_delete": false,
  "field_masking": false,
  "cdn_support": false,
  "categories_by_vendor": true,
  "product_premoderation": true,
  "vendor_debt_payout": false,
  "vendor_categories_fee": false,
  "master_products": true,
  "realtime_order_notify": true
}