Siprov API
Rumo TecnologiaSiprov
  • Início
  • Introdução
  • Configuração do Acesso
  • Teste
  • Erros
  • Ajuda
    • Nomenclaturas
    • Contato
  • Guia de Implementação
    • Apresentação
    • Autenticação
  • Referência da API
    • Introdução Técnica
      • Sobre
      • Autenticação
      • Empresa
      • Administração
        • Unidade (Loja)
        • Vendedor
      • Associado
        • Cartão de Crédito
      • Benefício
        • Cancelamento
        • Dependente
        • Tipo de Veículo
        • Benefício Veicular
        • Validação
        • Vencimento
        • Itens
        • Dependentes
      • Documentação/Vistoria
        • Tipos
        • Anexo
        • Documento
        • Foto
      • Financeiro
        • Cartão de Crédito
        • Forma de Pagamento
        • Tipo de Liquidação
        • Tipo de Título
        • Título
          • Boleto
          • Liquidar
          • Pagar
      • Evento
        • Orçamento
        • Situação de Evento
        • Tipo de Evento
      • Rede Credenciada
        • Clínica
        • Especialidade
        • Exame
        • Médico
        • Parceiro
          • Servico
          • Tipo
        • Região de Atendimento
      • Saúde
        • Marcação de Consulta
      • CRM
        • Lead
      • Integração Especial
        • Univers
        • Araújo
          • Empresas
      • 🔡Referência (Swagger)
      • ▶️Especificação (OpenAPI)
  • Gatilhos
    • Introdução
    • Referência
      • Acionamento
      • Benefício
      • Marcação de Consulta
      • Negócio de CRM
      • Evento
      • Help Desk
      • Rastreador
      • Título
      • Documentação/Vistoria
    • Especificação
  • Extras
    • 🔄Status
Fornecido por GitBook
Nesta página

Isto foi útil?

  1. Referência da API
  2. Introdução Técnica

Benefício

AnteriorCartão de CréditoPróximoCancelamento

Isto foi útil?

  • GETPesquisar Benefício
  • POSTGravar Benefício Básico

Pesquisar Benefício

get

Retorna a lista de benefícios conforme parâmetros.

Necessário informar um parâmetro de benefício ('placa', 'chassi', 'sequencial' ou 'numeroCartaoDesconto').

Autorizações
Parâmetros de consulta
cpfstringOpcional
cnpjstringOpcional
placastringOpcional
chassistring · máx: 20Opcional
sequencialinteger · int32 · máx: 2147483647Opcional
numeroCartaoDescontostringOpcionalPattern: ^\d{4} ?\d{2} ?\d ?\d{3} ?\d{3}$
situacaoBeneficiostringOpcional
codPlanointeger · int32 · máx: 2147483647Opcional
Respostas
200
Lista de benefícios
application/json
401
Não autorizado
text/plain
get
GET /siprov-api/ext/beneficio HTTP/1.1
Host: acesso.siprov.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "categoriaCnh": "A",
  "codBeneficio": 1,
  "codPessoa": 1,
  "cpfCnpj": "text",
  "dadosAdicionais": [
    {
      "nome": "text",
      "valor": {}
    }
  ],
  "dataCadastro": "text",
  "dataNascimento": "text",
  "email": "text",
  "endereco": {
    "bairro": "text",
    "cep": "text",
    "cidade": "text",
    "complemento": "text",
    "logradouro": "text",
    "numero": "text",
    "tipoEndereco": "text",
    "tipoLogradouro": "text",
    "uf": "text"
  },
  "idade": 1,
  "identidade": "text",
  "nomeConsultor": "text",
  "nomePessoa": "text",
  "nomePlanoPrincipal": "text",
  "nomeRepresentante": "text",
  "numeroCartaoDesconto": "text",
  "numeroCnh": "text",
  "sexo": "text",
  "situacao": "text",
  "telefoneCelular": "text",
  "telefoneFixo": "text",
  "tipoBeneficio": "text",
  "tipoSituacao": "text",
  "valorMensalidade": 1,
  "veiculo": {
    "anoFabricacao": 1,
    "anoModelo": 1,
    "ativo": true,
    "categoria": "text",
    "chassi": "text",
    "codigoFipe": "text",
    "combustivel": "text",
    "cor": "text",
    "marca": "text",
    "modelo": "text",
    "placa": "text",
    "renavam": "text",
    "semPlaca": true,
    "tipoVeiculo": "text",
    "valorParticipacao": 1,
    "valorProtegido": 1,
    "valorVeiculo": 1
  }
}

Gravar Benefício Básico

post

Grava o benefício, vinculando-o ao CPF/CNPJ indicado. O 'codPlano' deve ser obtido na lista de negociação. Envie a situação pelo nome ou simplesmente ativo como verdadeiro ou falso.

Autorizações
Corpo
ativobooleanOpcional
codBeneficiointeger · int32Opcional
codCartaoCreditointeger · int32Opcional
codConsultorinteger · int32Opcional
codFormaPagamentointeger · int32Opcional
codLojainteger · int32Opcional
codPlanointeger · int32 · mín: 1Obrigatório
codRepresentanteinteger · int32Opcional
cpfCnpjstringOpcional
diaVencimentointeger · int32 · mín: 1 · máx: 30Opcional
numeroCartaoDescontostringOpcional
situacaostringOpcional
Respostas
200
Benefício gravado com sucesso
application/json
401
Não autorizado
text/plain
post
POST /siprov-api/ext/beneficio HTTP/1.1
Host: acesso.siprov.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 311

{
  "ajustes": [
    {
      "descricao": "text",
      "regra": "Desconto",
      "tipo": "$",
      "validade": "text",
      "valor": 1
    }
  ],
  "ativo": true,
  "codBeneficio": 1,
  "codCartaoCredito": 1,
  "codConsultor": 1,
  "codFormaPagamento": 1,
  "codLoja": 1,
  "codPlano": 1,
  "codRepresentante": 1,
  "cpfCnpj": "text",
  "diaVencimento": 1,
  "numeroCartaoDesconto": "text",
  "situacao": "text"
}
{
  "codBeneficio": 1,
  "numeroCartaoDesconto": "text",
  "sequencial": 1
}