mkhair-sdk

SDK para integração com o provador virtual de cores de cabelo mKHair.

Instalação

Via CDN:

<script src="https://unpkg.com/mkhair-sdk/src/mkhair.js"></script>

Via npm:

npm install mkhair-sdk

Uso mínimo

// Abre o provador já provando o tom da página
mkhair.open({ type: 'iframe', sku: '1882' });

// Recebe itens adicionados ao carrinho
mkhair.addToCart(item => {
  // item = { sku, productName, colorName, quantity }
});

open(options, onReady)

| opção | obrigatório | descrição | |---|---|---| | type | sim | 'iframe' (overlay sobre a página) ou 'embed' (dentro de um container) | | sku | não | SKU do produto da página; o provador abre já com o tom aplicado | | host | não | host do provador da marca, sobrescreve o default (ex: https://provador.marca.com.br) | | brand | não | aceito por compatibilidade; quem identifica a marca é o host, então não entra na URL | | appUrl | não | URL absoluta pronta, sobrescreve host | | targetId | só no embed | id do elemento que recebe o provador | | width / height | não | dimensões do overlay, default 430x936 | | debug | não | liga logs verbosos do handshake e das mensagens |

Chamar open() de novo com outro sku recarrega o provador no tom novo.

Carrinho

mkhair.addToCart(item => { /* item escolhido no provador */ });
mkhair.removeFromCart(item => { /* item removido */ });

mkhair.getCart();               // itens acumulados
mkhair.removeFromCart('1882');  // remove por SKU

O provador não consulta estoque: ele oferece todos os tons publicados e devolve o SKU escolhido. Validar disponibilidade e tratar o erro é responsabilidade da loja.

Fechamento

mkhair.close(() => { /* usuário fechou pelo X do provador */ });
mkhair.close();                 // fecha via código

Métodos internos

applyColor, clearColor e getStatus são de uso interno da mK, para testes e calibragem, e não fazem parte do contrato de integração. A calibragem aprovada de cada tom (cor e parâmetros do motor) vive no app e não trafega por esses métodos, então um applyColor com o hex do swatch renderiza um tom diferente do aprovado. Para abrir num tom específico, use sku no open().