Skip to content

Como integrar uma venda

Ativação necessária

Caso você queira integrar uma venda ao seu serviço, é necessário entrar em contato com o suporte da Layers para ativar a integração em sua comunidade.

Como integrar uma venda

Após ter a opção de integração ativa em sua comunidade, você agora pode integrar uma venda.
Antes de irmos para o código, você precisa configurar um webhook associado à sua venda. Caso você não saiba como fazer isso, veja como criar um webhook.

Vamos imaginar que você configurou um webhook que será ativado toda vez que a venda tiver o status sale.approved. Esse webhook enviará os dados para a URL configurada. Com isso, você pode integrar uma venda aprovada ao seu sistema.

Se a sua venda for integrada com sucesso, você verá o seguinte status na aba de pedidos:

integrado_com_sucesso

Caso ocorra algum problema na integração, você poderá visualizar o erro na tela de qualidade de dados, identificada como Integrações no menu da área do administrador. Além disso, sua venda aparecerá assim na área de integrações:

integrado_falha

Boas práticas

Ao integrar uma venda, é uma boa prática fazer isso:

bash
curl -X GET https://api.layers.digital/v1/payments/sales/:SALEID \
  --H "Authorization: Bearer [TOKEN_DE_APLICACAO]" \
  --H "Community-Id: [NOME_DA_COMUNIDADE]"

Mesmo tendo o ID da venda no webhook, é sempre uma boa prática fazer essa requisição para assegurar que você irá realizar operações com dados atualizados e evitar erros.

Outra boa prática e fazer um catch após a lógica da sua integração. Por meio desse catch você consegue enviar para a tela de qualidade de dados os erros que aconteceram durante a sua integração.

javascript
try {
    // lógica da sua integração
} catch (error) {
    console.log(error)
    await axios.post(
    `sales/${sale.id}/events/emit`,
        {
        eventName: 'integration.error',
        eventComment: `Erro ao integrar a venda ${sale.code}`,
        integration: { status, metadata, reason },
        }
    )
}