Artigos sobre: Integrações

Como integrar com a API da Nemu?

A API da Nemu é uma ferramenta para interagir com a nossa plataforma e expandir as funcionalidades do seu aplicativo. Abaixo, vamos explicar como usar a API para enviar eventos de vendas.

Autenticação

Para autenticar o usuário, inclua o token do dashboard no header Authorization da sua requisição.

Gerando o Token do Usuário

Acesse os detalhes do dashboard.
Clique em Configurações.

Vá para Integração API Nemu e clique em Gerar token API.

Copie o token exibido.

Enviando Dados de Vendas para a Nemu

A API oferece duas rotas para criar e atualizar pedidos, permitindo compartilhar informações em tempo real com o dashboard.

URL base para requisições: https://developers.nemu.com.br/api/v1

POST /sales

Use esta rota para enviar informações de vendas.

Parâmetros da Transação/Pedido

Parâmetro	Descrição	Tipo
name *	Nome do produto ou pedido	string
transactionId *	ID da transação ou pedido	string
netValue *	Valor líquido da transação ou pedido	number
grossValue *	Valor bruto da transação ou pedido	number
status *	Status da transação ou pedido (paid, waiting_payment, cancelled, chargeback, refunded)	string
quantity *	Quantidade vendida na transação ou pedido	number
paymentType *	Método de pagamento (pix, billet, credit_card, other)	string
utm_source	Parâmetro utm_source	string
utm_campaign	Parâmetro utm_campaign	string
utm_medium	Parâmetro utm_medium	string
utm_content	Parâmetro utm_content	string
utm_term	Parâmetro utm_term	string
customerName *	Nome do comprador	string
customerEmail *	Email do comprador	string
customerPhone *	Número de celular ou telefone do comprador	string
date *	Data da venda (formato: YYYY-MM-DD)	string
orderCreatedAt	Data e hora da venda (formato: YYYY-MM-DD HH:MM:SS)	date
products	Lista de produtos do pedido (enviar quando houver mais de um produto)	array de produtos

Parâmetros para lista de produtos

Parâmetro	Descrição	Tipo
productId *	Id do produto	string
name *	Nome do produto	string
quantity *	Quantidade vendida do produto	number
netValue *	Valor liquido do produto	number
grossValue *	Valor bruto do produto	number
priceCost	Preço de custo do produto	number

Exemplo de requisição para um único produto:

{
    "name": "Nome do produto",
    "transactionId": "123",
    "netValue": 10,
    "grossValue": 30,
    "status": "paid",
    "quantity": 1,
    "paymentType": "pix",
    "utm_campaign": "opcional",
    "utm_content": "opcional",
    "utm_medium": "opcional",
    "utm_source": "opcional",
    "utm_term": "opcional",
    "customerName": "Nome do Cliente",
    "customerEmail": "emaildocliente@gmail.com",
    "customerPhone": "11912345678",
    "date": "2024-06-25",
    "orderCreatedAt": "2024-06-25 00:00:00",
    "priceCost": 5
}

Para pedidos com múltiplos produtos, use o formato abaixo:

{
    "name": "Nome do pedido",
    "transactionId": "123",
    "netValue": 20,
    "grossValue": 40,
    "status": "paid",
    "quantity": 1,
    "paymentType": "pix",
    "utm_campaign": "opcional",
    "utm_content": "opcional",
    "utm_medium": "opcional",
    "utm_source": "opcional",
    "utm_term": "opcional",
    "customerName": "Nome do Cliente",
    "customerEmail": "emaildocliente@gmail.com",
    "customerPhone": "11912345678",
    "date": "2024-06-25",
    "createdAt": "2024-06-25 00:00:00",
    "products": [
        {
            "productId": "1",
            "name": "Nome do Produto 1",
            "quantity": 1,
            "netValue": 10,
            "grossValue": 20,
            "priceCost": 5
        },
        {
            "productId": "2",
            "name": "Nome do Produto 2",
            "quantity": 1,
            "netValue": 10,
            "grossValue": 20,
            "priceCost": 5
        }
    ]
}

PUT /sales/:transactionId

Use esta rota para atualizar informações de um pedido existente.

Parâmetros para Atualização da Transação/Pedido

Parâmetro	Descrição	Tipo
status	Novo status da transação ou pedido (paid, waiting_payment, etc)	string
customerName	Novo nome do comprador	string
customerEmail	Novo email do comprador	string
customerPhone	Novo número de celular ou telefone do comprador	string
date	Nova data da venda (formato: YYYY-MM-DD)	string

Exemplo de requisição:

{
    "status": "paid",
    "customerName": "Novo Nome do Cliente",
    "customerEmail": "novocliente@gmail.com",
    "customerPhone": "11998765432",
    "date": "2024-06-25"
}

Certifique-se de incluir o header Authorization com seu token de API em todas as requisições.

Espero que isso torne mais claro como utilizar a API da Nemu para envio de eventos de vendas!

Atualizado em: 26/06/2024

Este artigo foi útil?

Obrigado!