API CRM
📌 O que é uma API?
Agora é possível acessar os dados do seu CRM de forma simples e segura, utilizando nossa API oficial. A seguir, você encontrará uma explicação direta e didática sobre como utilizar os principais recursos.
API é a sigla para Application Programming Interface, que significa Interface de Programação de Aplicação. É um conjunto de regras que permite que diferentes sistemas de software se comuniquem e compartilhem informações.
🔐 1. Geração do Token de Acesso
Para utilizar a API, é necessário um token de autenticação. Esse token garante que somente usuários autorizados acessem os dados da sua conta.
Como gerar:
Acesse o SolarZ CRM com seu login.
Vá até o menu do seu perfil de usuário.
Clique em "Gerar Token" e copie o código apresentado.
Guarde esse token. Ele será utilizado para autenticar suas requisições na API.

🌐 2. Acesso à documentação da API
Toda a documentação está disponível em um painel interativo chamado Swagger:
🔗 Acessar Swagger da API SolarZ CRM
Nesse painel, você pode:
Visualizar todos os endpoints disponíveis.
Testar requisições com seu token.
Entender os campos que serão retornados.
🔎 3. Endpoints disponíveis para exportação de dados
Abaixo estão listadas as principais rotas da API com suas funcionalidades:
👤 Usuários
GET
/open-api/users
: Lista todos os usuários.GET
/open-api/users/{id}
: Lista um usuário específico por ID.
💼 Negócios
GET
/open-api/deal
: Retorna negócios registrados no CRM. Permite filtrar por período.
📑 Propostas
GET
/open-api/proposals
: Lista propostas criadas no CRM.
📂 Pessoas e Organizações
GET
/open-api/client/persons
: Lista pessoas de contato cadastradas.GET
/open-api/client/organizations
: Lista empresas/organizações cadastradas.
📊 Funis de Vendas
GET
/open-api/pipeline/{id}
: Retorna os dados de um funil por ID.GET
/open-api/pipeline/stage/{id}
: Retorna os dados de uma etapa específica de um funil.
🎯 Motivos de Perda
GET
/open-api/reason-for-loss
: Lista os motivos de perda cadastrados no sistema.
📥 Canais de Origem
GET
/open-api/referral-sources
: Lista os canais de origem dos leads.
📅 Atividades
GET
/open-api/activities
: Lista registros de atividades da equipe (ligações, reuniões, tarefas etc).
💡 4. Exemplos práticos de uso (sem código)
Exemplo A: Conectar ao Power BI
Utilize o token de acesso para conectar o Power BI à API do SolarZ.
Importe dados de negócios, propostas ou pessoas.
Monte dashboards para análise de desempenho comercial.
Exemplo B: Exportar para Excel
Faça uma requisição com o token e baixe os dados em formato JSON.
Converta para CSV e abra no Excel para criar relatórios manuais.
Exemplo C: Integração com sistema interno
Integre o CRM com outros sistemas da sua empresa (ERP, atendimento, financeiro).
Utilize os endpoints para manter dados sincronizados entre plataformas.
🔄 Tipo de Integração: Exportação de Dados
Atualmente, a API do SolarZ CRM possui função exclusiva de exportação. Ou seja:
✅ É possível consultar e extrair dados do CRM para utilizar em outras plataformas.
❌ Ainda não é possível enviar ou importar dados para o CRM via API (por exemplo, criar negócios, editar propostas ou cadastrar novos clientes).
Essa estrutura foi desenvolvida com foco em oferecer transparência e flexibilidade para análise externa de dados, especialmente para:
Criação de dashboards personalizados (ex: Power BI, Google Data Studio);
Geração de relatórios gerenciais;
Integração com sistemas de BI, ERP ou ferramentas internas.
➡️ Assim que houver a liberação de endpoints para operações de escrita (importação), essa informação será atualizada na documentação oficial da API.
🆘 Precisa de Ajuda?
Caso tenha dúvidas ou encontre dificuldades, nossa equipe de suporte está pronta para te ajudar. Entre em contato pelo chat do CRM SolarZ pelo número +55 84 98124-4187 ou envie um e-mail para suporte@solarz.com.br. 🚀