Documentação da API de Kanban

Base URL

• Produção: https://nuzap.com.br/api
• Desenvolvimento: http://localhost/meusprodutosonline/api

Autenticação

Todas as requisições necessitam do token de autenticação no header:

Authorization: Bearer YOUR_API_TOKEN

Endpoints

1. Listar Kanban

Retorna todos os boards e cards do kanban de uma loja.

GET /kanban?store={store}

Headers

• Content-Type: application/json
• Authorization: Bearer {token}

Query Parameters

Exemplo de Requisição

GET /kanban?store=zatinni
Content-Type: application/json
Authorization: Bearer E5YmZkNDE3MjU0YzFmZTI1

2. Criar Board

Cria um novo board no kanban.

POST /kanban/board

Headers

• Content-Type: application/json
• Authorization: Bearer {token}

Body Parameters

Exemplo de Requisição

{
    "store": "zatinni",
    "name": "Outro Board"
}

3. Criar Card

Cria um novo card em um board específico.

POST /kanban/card

Headers

• Content-Type: application/json
• Authorization: Bearer {token}

Body Parameters

Exemplo de Requisição

{
    "store": "zatinni",
    "name": "João Silva",
    "phone": "31973493081",
    "stage": 114,
    "utm_source": "google",
    "utm_medium": "cpc",
    "utm_campaign": "black_friday"
}

4. Mover Card

Move um card para outro board.

POST /kanban/card/{card_id}/move

Headers

• Content-Type: application/json
• Authorization: Bearer {token}

URL Parameters

Body Parameters

Exemplo de Requisição

{
    "store": "zatinni",
    "stage": 111
}

OBS.: Se não enviar "stage" (a etapa do funil que quer mover), irá mover para a próxima etapa.

ex.: Etapas: etapa 1, etapa 2, etapa 3. requisição: POST /kanban/card/{card_id}/move {store: {uriStore}} >> move para a etapa 2 requisição: POST /kanban/card/{card_id}/move {store: {uriStore}} >> move para a etapa 3

Exemplo de Código Javascript

// Função para carregar os boards
const loadBoards = async () => {
  try {
    const response = await fetch('/api/kanban');
    const data = await response.json();
    setBoards(data);
  } catch (error) {
    console.error('Failed to load boards:', error);
  }
};

// Função para mover um card
const moveCard = async (cardId, targetBoardId, position) => {
  try {
    await fetch(`/api/kanban/card/${cardId}/move`, {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json',
      },
      body: JSON.stringify({
    store: storeUri,
        stage: targetBoardId,
        position: position
      })
    });

    // Recarregar boards após mover
    loadBoards();
  } catch (error) {
    console.error('Failed to move card:', error);
  }
};

5. Editar Card

Atualiza informações de uma oportunidade específica.

PUT /kanban/card/{deal_id}

Headers

• Content-Type: application/json
• Authorization: Bearer {token}

Body Parameters

6. Apagar Card

Remove uma oportunidade específica.

DELETE /kanban/card/{deal_id}?store={store}

Headers

• Content-Type: application/json
• Authorization: Bearer {token}

Query Parameters

Parâmetros de Rastreamento (UTM)

Os parâmetros UTM são utilizados para rastrear a origem das oportunidades:

Códigos de Status

Limites de Requisição

• Não exceda os limites da API.

Observações

• Todos os timestamps estão em UTC
• O token de API deve ser mantido em segurança
• Para suporte, contate: [email protected]

Documentação API - Gerenciamento de Stages (Etapas)

Esta documentação complementa a documentação principal do Kanban, detalhando as operações relacionadas aos stages (etapas/colunas) do quadro.

Base URL

• Produção: https://nuzap.com.br/api
• Desenvolvimento: http://localhost/meusprodutosonline/api

Autenticação

Todas as requisições necessitam do token de autenticação no header:

Authorization: Bearer YOUR_API_TOKEN

Endpoints

1. Criar Stage

Cria uma nova etapa no kanban.

POST /stage

Headers

• Content-Type: application/json
• Authorization: Bearer {token}

Body Parameters

Exemplo de Requisição

{
    "store": "zatinni",
    "name": "Em Andamento"
}

2. Buscar Stage Específico

Retorna informações de uma etapa específica.

GET /stage/{stage_id}?store={store}

Headers

• Content-Type: application/json
• Authorization: Bearer {token}

Query Parameters

3. Listar Stages

Retorna todas as etapas da loja.

GET /stage?store={store}

Headers

• Content-Type: application/json
• Authorization: Bearer {token}

Query Parameters

4. Atualizar Stage

Atualiza informações de uma etapa específica.

PUT /stage/{stage_id}

Headers

• Content-Type: application/json
• Authorization: Bearer {token}

Body Parameters

Exemplo de Requisição

{
    "store": "zatinni",
    "name": "Em Processamento",
    "position": 3
}

5. Deletar Stage

Remove uma etapa específica.

DELETE /stage/{stage_id}?store={store}

Headers

• Content-Type: application/json
• Authorization: Bearer {token}

Query Parameters

Códigos de Status

Observações

• A posição das etapas é baseada em um sistema de ordenação numérico
• Ao deletar uma etapa, certifique-se que não existem cards associados
• O parâmetro store é obrigatório em todas as requisições GET
• Todas as alterações são registradas para fins de auditoria

Limites de Requisição

• Favor não exceder o limite da API.

Suporte

Para suporte técnico ou dúvidas sobre a API, contate:

• Email: [email protected]
• Documentação completa: https://docs.nuzap.com.br

Documentação API - Gerenciamento de Deals (Oportunidades)

Esta documentação abrange a gestão de deals (oportunidades/negócios) no sistema de kanban, complementando as funcionalidades básicas do quadro.

Base URL

• Produção: https://nuzap.com.br/api
• Desenvolvimento: http://localhost/meusprodutosonline/api

Autenticação

Todas as requisições necessitam do token de autenticação no header:

Authorization: Bearer YOUR_API_TOKEN

Endpoints

1. Criar Deal

Cria uma nova oportunidade no sistema.

POST /deal

Headers

• Content-Type: application/json
• Authorization: Bearer {token}

Body Parameters

Exemplo de Requisição

{
    "store": "zatinni",
    "name": "João Silva",
    "phone": "31999999999",
    "stage": 114,
    "utm_source": "google",
    "utm_medium": "cpc"
}

2. Buscar Deal Específico

Retorna informações de uma oportunidade específica.

GET /deal/{deal_id}?store={store}

Headers

• Content-Type: application/json
• Authorization: Bearer {token}

Query Parameters

3. Listar Deals

Retorna todas as oportunidades da loja.

GET /deal?store={store}

Headers

• Content-Type: application/json
• Authorization: Bearer {token}

Query Parameters

4. Atualizar Deal

Atualiza informações de uma oportunidade específica.

PUT /deal/{deal_id}

Headers

• Content-Type: application/json
• Authorization: Bearer {token}

Body Parameters

5. Deletar Deal

Remove uma oportunidade específica.

DELETE /deal/{deal_id}?store={store}

Headers

• Content-Type: application/json
• Authorization: Bearer {token}

Query Parameters

Parâmetros de Rastreamento (UTM)

Os parâmetros UTM são utilizados para rastrear a origem das oportunidades:

Códigos de Status

Boas Práticas

1. Sempre inclua o parâmetro store nas requisições
2. Utilize os parâmetros UTM para melhor análise de marketing
3. Mantenha o número de telefone em formato consistente
4. Use o campo rating para priorizar oportunidades

Limites e Restrições

• Não exceder os limites da API.
• Phone deve estar em formato válido

Feature Recuperação de Contato:

No fluxo de contato com o comprador e após o contato, adicionar a oportunidade ao kanban sem enviar o email, então no momento da compra o comprador é recuperado e integrado à venda.

Suporte

Para suporte técnico ou dúvidas:

• Email: [email protected]
• Documentação completa: https://docs.nuzap.com.br