Criação de API para Disponibilização de Prospects e Pedidos (JSON)

Histórico de Alterações

Data	Quem	Comentários
17/09/2025	Renato Lima	Criação do documento

Necessidade

O contratante identificou a necessidade de integrar os dados de clientes prospect e de pedidos/orçamentos com o sistema de CRM. Essa integração tem como objetivo otimizar o fluxo comercial, permitindo que as informações registradas na aplicação atual sejam automaticamente enviadas ao CRM, garantindo maior eficiência no acompanhamento das oportunidades, além de evitar retrabalho e inconsistências entre os sistemas.

Solução

Para atender a essa necessidade, será disponibilizada uma API em formato JSON, por meio da qual os dados de clientes prospect e de pedidos/orçamentos poderão ser consumidos pelo CRM. A estrutura da API seguirá um modelo previamente definido, garantindo padronização, segurança e escalabilidade. Essa solução permitirá a automatização da integração, assegurando flexibilidade para futuras evoluções e ampliações no processo.

• Disponibilização dos dados de clientes prospect e pedidos/orçamentos em formato JSON através da API.

• Definição do modelo de dados e estrutura de integração.

• Implementação de mecanismos básicos de autenticação e segurança de acesso à API.

Campo CRM	Campo GeoSales	Observações
DATA ULTIMA ATUALIZACAO	Renato Lima	Criação do documento
ID ORÇAMENTO	CD_PEDIDO_PALM	Cód do pedido ou Orçamento
CNPJ	NR_CNPJ_CPF	Criação do documento
NOME / RAZAO SOCIAL	NM_CLIENTE/NM_FANTASIA	Criação do documento
ID ERP TOTVS	CD_CLIENTE_REFERENCIA	Criação do documento
ID GEOSALES do CLIENTE/PROSPECT	CD_CLIENTE	Criação do documento
DATA CRIACAO ORÇAMENTO	DT_EMISSAO	Criação do documento
VALOR ORÇAMENTO	VR_PEDIDO	Criação do documento
SITUACAO ORCAMENTO	CD_ST_SITUACAO	Criação do documento
DATA PREVISAO ORÇAMENTO	DT_VENCIMENTO	Criação do documento
CALOR % PROBABILIDADE	CD_MOTIVO PEDIDO - DS_MOTIVO	Criação do documento
MEIO PAGAMENTO	CD_MEIO_PGTO	Criação do documento
CONDICAO PAGAMENTO	CD_COND_PGTO	Criação do documento
FRETE	ID_TIPO_FRET	Criação do documento
TRANSPORTADORA	CD_TRANSPORTADORA	Criação do documento
ID PEDIDO	CD_PEDIDO_PALM	Criação do documento
DT CRIACAO do PEDIDO	DT_EFETIVACAO	Criação do documento
SITUAÇÃO PEDIDO	CD_ST_PEDIDO	Criação do documento
ID VEDEDOR/REPRESENTANTE	CD_VENDEDOR	Criação do documento
NOME DO VENDEDOR/REPRESENTANTE	NM_VENDEDOR	Criação do documento
DATA CANCELAMENTO	DT_CANCELAMENTO	Criação do documento
MOTIVO CANCELAMENTO	CD_MOTIVO_CANCELAMENTO	Criação do documento
NF (Quando faturado)	CD_NOTA_FISCAL	Criação do documento
DT NF	DT_EMISSAO(NOTA FISCAL)	Criação do documento

Regras de Negócio

[RN1] - A API deve disponibilizar apenas os dados de clientes prospect, pedidos/orçamentos, Item em orçamento, status de atualização quando forem cancelado e se foram faturados e que estejam devidamente cadastrados e ativos no sistema de origem.

[RN2] - A API deve disponibilizar sempre os dados atualizados do sistema de origem. Qualquer alteração em prospects ou pedidos refletirá automaticamente nos dados expostos pela API.

[RN3] - Todos os dados expostos devem seguir o padrão JSON, estruturado conforme o modelo previamente definido.

[RN4] - A responsabilidade pelo consumo, tratamento e armazenamento dos dados é do sistema CRM. A API não realiza transformações ou persistência fora do escopo definido.

[RN5] - A API deve estar disponível em regime contínuo, salvo em períodos de manutenção programada.

Anexos

Aprovação

Considero aprovada a documentação da funcionalidade especificada acima, e autorizo a implementação da mesma no Sistema GeoSales, em nome da Organização a qual estou vinculado.

GeoSales

Setor	Aprovado Por	Data
Desenvolvimento - GeoSales	Pessoa que aprovou	00/00/0000
Integração - GeoSales	Pessoa que aprovou	00/00/0000
Configurações - GeoSales	Pessoa que aprovou	00/00/0000

Empresa solicitante

Setor	Aprovado Por	Data
Gerente TI - Cliente	Pessoa que aprovou	00/00/0000
Gerente de Projeto - Cliente	Pessoa que aprovou	00/00/0000
Gerente Comercial - Cliente	Pessoa que aprovou	00/00/0000