API-CRM
Visão Geral
API de Integração para Parceiros - Documentação completa dos endpoints disponíveis para integração de contatos e gerenciamento de tokens.
Contatos:
Termos de Serviço: https://www.pmweb.com.br/
Autenticação
A API utiliza dois tipos de autenticação:
Bearer Authentication (JWT)
Usado para endpoints de integração de contatos.
Header:
Endpoints
Criar/Atualizar Contato
Cria ou atualiza um contato através da integração. Se o contato já existir (por Email, Id ou NumPessoa), ele será atualizado. Caso contrário, um novo contato será criado.
Endpoint: POST /integration/crm/
Autenticação: Bearer Token (JWT)
Request Body
Campos Obrigatórios:
Email (string, formato email)
Grupos (array com pelo menos um grupo)
Campos Opcionais:
Id: ID do contato (usado para atualização)
NumPessoa: Número da pessoa (usado para atualização)
Nome: Nome do contato
SobreNome: Sobrenome do contato
Cidade: Cidade
Estado: Estado/UF
Pais: País
Telefone: Telefone
CPF: CPF
DiaNascimento: Dia de nascimento (1-31)
MesNascimento: Mês de nascimento (1-12)
AnoNascimento: Ano de nascimento
Coringa1 a Coringa17: Campos customizados
GruposAlternativos: Grupos alternativos para atualização
RecebeEmail: Se o contato aceita receber emails (boolean)
PoliticaConsentimento: Dados de consentimento LGPD
AceitouConsentimento: 0 = Não aceitou, 1 = Aceitou
NivelConsentimento: Nível do consentimento (ex: Promocional, Transacional)
TextoLegal: Texto legal aceito
Ip: IP do usuário (preenchido automaticamente se não fornecido)
Navegador: User agent (preenchido automaticamente se não fornecido)
Origem: Origem da requisição (preenchido automaticamente se não fornecido)
Responses:
201 Created - Novo contato criado
200 OK - Contato atualizado
400 Bad Request - Dados inválidos
401 Unauthorized - Token inválido ou não fornecido
Consultar Contato
Retorna os dados de um contato através do hash criptografado do NumPessoa. Este hash é retornado ao criar/atualizar um contato.
Endpoint: GET /integration/crm/{HASHNUMPESSOA}
Autenticação: Bearer Token (JWT)
Path Parameters:
HASHNUMPESSOA (string, obrigatório): Hash criptografado do NumPessoa retornado na criação/atualização do contato.
Responses:
200 OK - Dados do contato
400 Bad Request - Hash inválido ou erro ao descriptografar
401 Unauthorized - Token inválido ou não fornecido
404 Not Found - Não existe integração com este identificador
Schemas
Contact
Error
Exemplos de Uso
Exemplo 1: Criar Novo Contato
Exemplo 2: Atualizar Contato Existente
Exemplo 3: Consultar Contato
Notas Importantes
Segurança: O campo NumPessoa sempre retorna 0 nas consultas por motivos de segurança. Use o HASHNUMPESSOA para identificação.
LGPD: Utilize o objeto PoliticaConsentimento para registrar o consentimento do usuário conforme a LGPD.
Grupos: Ao criar um contato, use o campo Grupos. Para atualizar, você pode usar GruposAlternativos.
Campos Customizados: Os campos Coringa1 a Coringa17 podem ser usados para armazenar informações customizadas específicas da sua integração.
Atualização: Para atualizar um contato, forneça o Id, NumPessoa ou Email do contato existente.