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
  3. Benefício

Benefício Veicular

AnteriorTipo de VeículoPróximoValidação

Isto foi útil?

Gravar Benefício Veicular

post

Grava o benefício, vinculando-o ao CPF/CNPJ indicado. Envie a situação pelo nome ou simplesmente ativo como verdadeiro ou falso. Atente-se para os seguintes campos, que tem opções fixas:

  • 'categoria': BICICLETA | CAMINHAO | LEVE | MOTOCICLETA | PICKUP | UTILITARIO | ONIBUS | OUTRO
  • 'combustivel': GASOLINA | ETANOL | FLEX | DIESEL | GNV | ELETRICO | OUTRO
Autorizações
Corpo
anoFabricacaointeger · int32 · mín: 1900 · máx: 2099Opcional
anoModelointeger · int32 · mín: 1900 · máx: 2099Opcional
ativobooleanOpcional

Envie true se o veículo estiver ativo no sistema ou false se estiver inativo.

categoriastring · enumOpcionalValores possíveis:
chassistring · mín: 5 · máx: 35OpcionalPattern: ^([A-Z0-9]{5,35})?$
codBeneficiointeger · int32 · mín: 1 · máx: 2147483647Opcional

Este código é retornado pelo Siprov após gravar o benefício. Deve ser salvo pelo cliente e reenviado nas requisições seguintes. Se não for enviado, a requisição criará novo benefício.

codCartaoCreditointeger · int32Opcional

Informe o código do Cartão de Crédito previamente cadastrado e recuperado no respectivo método.

codConsultorinteger · int32 · mín: 1 · máx: 2147483647Opcional

Informe o código do consultor se quiser definir o consultor.

codFormaPagamentointeger · int32Opcional

Informe o código da Forma de Pagamento previamente cadastrado e recuperado no respectivo método.

codLojainteger · int32 · mín: 1 · máx: 2147483647Opcional

Os valores disponíveis para o cliente são retornados pelo método de autenticação.

codPlanointeger · int32 · mín: 1 · máx: 2147483647Obrigatório

Envie um dos planos disponíveis na consulta de negociação.

codRepresentanteinteger · int32 · mín: 1 · máx: 2147483647Opcional

Informe o código do representante se quiser definir o representante.

codigoFipestringOpcionalExample: 999999-9Pattern: ^(\d{6}\-\d)?$
combustivelstring · enumOpcionalValores possíveis:
corstring · máx: 20Opcional
cpfCnpjstringOpcional

Informe o CPF/CNPJ com ou sem máscara.

dataAdesaostring · máx: 10Opcional

Data de adesão do benefício.

Example: dd/MM/yyyyPattern: ^(\d{2}/\d{2}/\d{4})?$
diaVencimentointeger · int32 · mín: 1 · máx: 30Opcional
excluirPlanobooleanOpcional

Envie true para excluir o plano do benefício (caso exista) ou false para incluí-lo (caso não exista).

marcastring · mín: 2 · máx: 45Opcional
modelostring · mín: 1 · máx: 60Opcional
numeroPassageirosinteger · int32 · mín: 1 · máx: 999Opcional
numeroPortasinteger · int32 · mín: 1 · máx: 10Opcional
placastringOpcional
renavamstring · máx: 35Opcional
situacaostringOpcional

Envie o nome da situação de benefício.

tipoVeiculostring · máx: 45Opcional

Descrição do tipo de veículo

valorProtegidonumberOpcional
valorVeiculonumberOpcional
Respostas
200
Benefício gravado com sucesso
application/json
401
Não autorizado
text/plain
post
POST /siprov-api/ext/beneficio/veicular HTTP/1.1
Host: acesso.siprov.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 622

{
  "ajustes": [
    {
      "descricao": "text",
      "regra": "Desconto",
      "tipo": "$",
      "validade": "text",
      "valor": 1
    }
  ],
  "anoFabricacao": 1,
  "anoModelo": 1,
  "ativo": true,
  "categoria": "MOTOCICLETA",
  "chassi": "text",
  "codBeneficio": 1,
  "codCartaoCredito": 1,
  "codConsultor": 1,
  "codFormaPagamento": 1,
  "codLoja": 1,
  "codPlano": 1,
  "codRepresentante": 1,
  "codigoFipe": "999999-9",
  "combustivel": "GASOLINA",
  "cor": "text",
  "cpfCnpj": "text",
  "dataAdesao": "dd/MM/yyyy",
  "diaVencimento": 1,
  "excluirPlano": true,
  "marca": "text",
  "modelo": "text",
  "numeroPassageiros": 1,
  "numeroPortas": 1,
  "placa": "text",
  "renavam": "text",
  "situacao": "text",
  "tipoVeiculo": "text",
  "valorProtegido": 1,
  "valorVeiculo": 1
}
{
  "codBeneficio": 1,
  "numeroCartaoDesconto": "text",
  "sequencial": 1
}