💼 CRM API

API completa para gestão de pipelines de vendas, negócios, etapas e análise comercial.

✨ Sales Pipeline Management

Gerencie todo o funil de vendas com pipelines customizados, etapas flexíveis e automações.

Introdução

O módulo CRM oferece uma solução completa para gestão comercial:

  • Criar e gerenciar múltiplos pipelines de vendas
  • Configurar etapas personalizadas por pipeline
  • Acompanhar negócios através do funil
  • Analisar conversão e performance de vendas
  • Integrar com contatos e tarefas
  • Campos customizados por negócio

Pipelines

Pipelines representam funis de vendas diferentes. Você pode ter múltiplos pipelines para diferentes produtos, segmentos ou processos de venda.

GET

/v1/crm-pipelines

Listar pipelines

POST

/v1/create-crm-pipelines

Criar pipeline

PATCH

/v1/update-crm-pipelines

Atualizar pipeline

POST

/v1/archive-crm-pipelines/{id}

Arquivar pipeline

Exemplo: Criar pipeline 
const response = await fetch(
  'https://api.atys.pro/v1/create-crm-pipelines',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer YOUR_API_KEY'
    },
    body: JSON.stringify({
      name: 'Vendas B2B',
      description: 'Pipeline para vendas corporativas',
      color: '#8b5cf6',
      is_active: true,
      default_currency: 'BRL'
    })
  }
);

const pipeline = await response.json();
console.log('Pipeline criado:', pipeline.data.id);

Etapas

Cada pipeline possui etapas que representam as fases do processo de vendas.

GET

/v1/crm-stages

Listar etapas

POST

/v1/create-crm-stages

Criar etapa

POST

/v1/reorder-crm-stages

Reordenar etapas

Exemplo: Criar etapas de um pipeline 
const stages = [
  {
    name: 'Prospecção',
    probability: 10,
    order: 1,
    color: '#64748b'
  },
  {
    name: 'Qualificação',
    probability: 25,
    order: 2,
    color: '#3b82f6'
  },
  {
    name: 'Proposta',
    probability: 50,
    order: 3,
    color: '#f59e0b'
  },
  {
    name: 'Negociação',
    probability: 75,
    order: 4,
    color: '#8b5cf6'
  },
  {
    name: 'Ganho',
    probability: 100,
    order: 5,
    color: '#22c55e',
    is_won: true
  },
  {
    name: 'Perdido',
    probability: 0,
    order: 6,
    color: '#ef4444',
    is_lost: true
  }
];

for (const stage of stages) {
  await fetch('https://api.atys.pro/v1/create-crm-stages', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer YOUR_API_KEY'
    },
    body: JSON.stringify({
      ...stage,
      crm_pipeline_id: pipelineId
    })
  });
}

Negócios

Negócios são as oportunidades de venda que percorrem as etapas do pipeline.

GET

/v1/crm-businesses

Listar negócios

POST

/v1/create-crm-businesses

Criar negócio

PUT

/v1/crm-businesses-move-to-stage/{id}

Mover negócio entre etapas

POST

/v1/clone-crm-businesses

Clonar negócio

POST

/v1/transfer-crm-businesses

Transferir negócio para outro usuário

Exemplo: Criar negócio 
const response = await fetch(
  'https://api.atys.pro/v1/create-crm-businesses',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer YOUR_API_KEY'
    },
    body: JSON.stringify({
      title: 'Venda para Empresa XYZ',
      description: 'Renovação do contrato anual',
      crm_pipeline_id: 1,
      crm_stage_id: 2, // Qualificação
      contact_id: 456,
      value: 50000.00,
      currency: 'BRL',
      expected_close_date: '2025-12-31',
      crm_source_id: 3, // Inbound
      user_id: 10, // Responsável
      tags: ['renovacao', 'prioritario'],
      custom_fields: {
        numero_funcionarios: '50-100',
        segmento: 'tecnologia',
        decisor: 'CTO'
      }
    })
  }
);

const business = await response.json();
console.log('Negócio criado:', business.data.id);
🔍 Filtros disponíveis para negócios:
  • crm_pipeline_id - Filtrar por pipeline
  • crm_stage_id - Filtrar por etapa
  • user_id - Filtrar por responsável
  • contact_id - Filtrar por contato
  • value_min / value_max - Filtro de valor
  • expected_close_date_from / to - Data de fechamento
  • is_archived - Negócios arquivados

Fontes

Rastreie de onde vêm seus leads e negócios.

GET

/v1/crm-sources

Listar fontes

POST

/v1/crm-sources

Criar fonte

Campos Customizados

Adicione campos personalizados aos negócios para capturar informações específicas do seu processo.

GET

/v1/crm-custom-fields

Listar campos customizados

POST

/v1/create-crm-custom-fields

Criar campo customizado

POST

/v1/reorder-crm-custom-fields

Reordenar campos

Relatórios e Análises

A API oferece diversos endpoints de relatórios para análise do pipeline.

GET

/v1/crm-pipelines-reports/{id}/conversion-rate

GET

/v1/crm-pipelines-reports/{id}/average-ticket

GET

/v1/crm-pipelines-reports/{id}/forecast-trend

GET

/v1/crm-pipelines-reports/{id}/user-ranking

📊 Relatórios disponíveis:
  • Taxa de conversão por etapa
  • Valor total de negócios
  • Ticket médio
  • Velocidade de fechamento
  • CAC e LTV
  • Previsão de vendas
  • Performance por vendedor
  • Análise de fontes
  • Motivos de perda
Exemplo: Obter taxa de conversão 
const response = await fetch(
  'https://api.atys.pro/v1/crm-pipelines-reports/1/conversion-rate?period=last_30_days',
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);

const report = await response.json();
// {
//   "overall_conversion": 23.5,
//   "by_stage": [
//     {"stage": "Qualificação", "conversion": 45.2},
//     {"stage": "Proposta", "conversion": 62.8},
//     {"stage": "Negociação", "conversion": 74.5}
//   ]
// }

Webhooks Disponíveis

  • crm.business.created - Negócio criado
  • crm.business.updated - Negócio atualizado
  • crm.business.stage_changed - Negócio mudou de etapa
  • crm.business.won - Negócio ganho
  • crm.business.lost - Negócio perdido
  • crm.business.archived - Negócio arquivado

Esta página foi útil?

← Contatos API
Webhooks →