Boas práticas

​

Este guia define as diretrizes técnicas para desenvolver customizações e scripts no Editor de Código da sua loja virtual. O objetivo é garantir segurança, performance e a integração correta com os recursos nativos da plataforma.

​

Segurança e consumo de APIs

• Use só endpoints públicos. São as rotas da API feitas para rodar no frontend, sem autenticação privilegiada. Veja a lista completa em Referência da API — Público.
• Prefira a instância api do axios. O Rocket já expõe essa instância pronta, com os headers e UTMs certos. Não monte a URL nem os headers na mão com fetch. Veja Plugins — Axios.

​

Exemplo

import api from '@/modules/axios/api';

async function loadProduct(slug) {
    try {
        const { data } = await api.get(`/catalog/products/${slug}`);
        return data;
    } catch (error) {
        console.error('Erro ao carregar produto:', error);
    }
}

​

Performance

• Consulte a Store antes de chamar a API. Produto atual, ambiente e carrinho já chegam prontos na Store, carregados a partir de window.data e window.Yampi.
• Cacheie dados que mudam pouco. Categorias, marcas e outras listas com baixa frequência de alteração podem usar o mixin cache, que grava no localStorage com TTL. Veja Mixins — cache.