> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nemu.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Como integrar com a API da Nemu?

A API da Nemu permite que você envie eventos de vendas para o dashboard em tempo real, expandindo as funcionalidades do seu aplicativo.

## Ambientes

A API está disponível em dois ambientes. Cada um possui seu próprio dashboard,
onde o token de API é gerado:

| Ambiente | Dashboard | URL base da API |
| - | - | - |
| Produção | [dashboards.nemu.com.br](https://dashboards.nemu.com.br) | `https://developers.nemu.com.br/api/v1` |
| Staging | [stg.dashboards.nemu.com.br](https://stg.dashboards.nemu.com.br) | `https://developers.stg.nemu.com.br/api/v1` |

O acesso ao dashboard de staging é liberado por código de convite. Entre em
contato com o time da Nemu para receber o código e criar sua conta nesse
ambiente.

> [!NOTE]
>
> Use o ambiente de staging para validar sua integração antes de enviar vendas
> reais. Gere o token de API no dashboard do mesmo ambiente em que fará as
> requisições: para usar a API de staging, gere o token em
> [stg.dashboards.nemu.com.br](https://stg.dashboards.nemu.com.br).

## Autenticação

Inclua o token do dashboard no header `Authorization` da sua requisição.

### Gerando o Token do Usuário

1. Na Nemu, acesse **Configurações** > **API Nemu**.

![](https://mintcdn.com/nemu/v7js4A8miNuFwGe1/assets/pages/api/token/1.png?fit=max\&auto=format\&n=v7js4A8miNuFwGe1\&q=85\&s=40a013cc22ba4ffa207045787ab194f0)

2. Clique em **Gerar token**.

![](https://mintcdn.com/nemu/v7js4A8miNuFwGe1/assets/pages/api/token/2.png?fit=max\&auto=format\&n=v7js4A8miNuFwGe1\&q=85\&s=f69d570451712a9eae6b5d2d532edf05)

3. Copie o token exibido.

![](https://mintcdn.com/nemu/v7js4A8miNuFwGe1/assets/pages/api/token/3.png?fit=max\&auto=format\&n=v7js4A8miNuFwGe1\&q=85\&s=b12d479f9b5dfd9919353a5c6d50d7ae)

> [!TIP]
>
> Mantenha o token em segurança. Ele é único e deve ser usado apenas em
> requisições autorizadas.

## Recuperando UTMs para Integração

Para enviar dados de vendas com informações de rastreamento (UTMs), você deve recuperar essas informações de uma das três fontes disponíveis na seguinte ordem de prioridade:

### Fontes de UTMs Disponíveis

1. **Variável Global** (Prioridade 1): `window.trackingNemu.nemuUtms`
   * Retorna um objeto `URLSearchParams` com as UTMs
   * Disponível quando o pixel da Nemu está carregado na página

2. **Cookie** (Prioridade 2): `nemuUtmsTrack`
   * Cookie contendo as informações de UTMs em formato de query string

3. **LocalStorage** (Prioridade 3): `nemu:utmsTrack`
   * Armazenamento local com as UTMs em formato de query string

### Implementação Recomendada

```javascript theme={null}
// Função auxiliar para obter cookies
function getCookie(name) {
  const value = `; ${document.cookie}`;
  const parts = value.split(`; ${name}=`);
  if (parts.length === 2) return parts.pop().split(";").shift();
}

// Recuperação de UTMs com fallback
const utms =
  window.trackingNemu?.nemuUtms?.toString() ||
  getCookie("nemuUtmsTrack") ||
  localStorage.getItem("nemu:utmsTrack");
```

### Estratégia de Fallback

A implementação deve seguir a ordem de prioridade, tentando primeiro a variável global, depois o cookie e por último o localStorage. Isso garante que as UTMs sejam capturadas independentemente de como o usuário chegou à página.

> [!TIP]
>
> A variável global `window.trackingNemu.nemuUtms` só estará disponível se o
> pixel da Nemu estiver carregado na página. Use o operador de encadeamento
> opcional (`?`) para evitar erros.

## Enviando Dados de Vendas

A API oferece duas rotas principais para criar e atualizar pedidos:

* `POST /sales` para criar vendas
* `PUT /sales/:transactionId` para atualizar vendas

> [!TIP]
>
> Certifique-se de incluir o header `Authorization` com seu token de API em
> todas as requisições.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.