Consultas disponíveis por API

URL Principal / BASE

https://painel.valideinfoweb.com.br/rdrv2/api Acesse o sistema de web service.

// https://painel.valideinfoweb.com.br/rdrv2/api

{
  "title": "API Painel de Consultas",
  "descricao": "Destinada a clientes com sistema próprio!",
  "headers": {
    "api-token": "Token do cliente",
    "Authorization": "Basic base64encode(login:senha)"
  },
  "endpoints": {
    "/consultas/detalhes": {
      "title": "Detalhes de uma consulta",
      "description": "Retorna os detalhes da consulta",
      "parans": {
        "consulta": "Token da consulta"
      }
    },
    "/consultas/list": {
      "title": "Lista de consulta",
      "description": "Listagem de consultas com poucos detalhes",
      "parans": {
        "page": "Página",
        "forpage": "Quantidade de consultas por página"
      }
    },
    "/consultar": {
      "title": "Iniciar uma nova consulta",
      "description": "Cria uma nova consulta consumindo do saldo do cliente",
      "parans": {
        "produto": "Token do produto",
        "param": "Parâmetro a ser utilizado no produto, ex: placa,motor,chassi,cpf,cnpj...",
        "value": "Valor do parâmetro a ser buscado",
        "urlNotification": "URL que será acionada após a liberação de uma consulta por um operador."
      }
    },
    "/produtos": {
      "title": "Lista de produtos",
      "description": "Listagem de produtos disponíves para o cliente",
      "parans": null
    },
    "/clientes": {
      "title": "Lista de clientes",
      "description": "Listagem de clientes",
      "parans": {
        "cliente": "ID do cliente para obter os detalhes individual (OPCIONAL)"
      }
    },
    "/clientes/faturas": {
      "title": "Lista de faturas",
      "description": "Listagem de faturas do cliente",
      "parans": {
        "cliente": "ID do cliente para ver as faturas",
        "fatura": "ID da fatura para obter os detalhes (OPCIONAL)"
      }
    },
    "/clientes/extrato": {
      "title": "Lista de extrato",
      "description": "Listagem de extrato do cliente",
      "parans": {
        "cliente": "ID do cliente para ver o extrato",
        "fatura": "ID da fatura de referência"
      }
    }
  },
  "result": 1
}

Listar Produtos Disponiveis

https://painel.valideinfoweb.com.br/rdrv2/api/produtos

/ https://painel.valideinfoweb.com.br/rdrv2/api/produtos

{
  "message": "É necessário que envie suas credencias para autenticação",
  "result": 0
}

Listagem de produtos disponíveis para o cliente, este endereço é muito importante requisitar para identificar a consulta que deseja fazer e copiar o TOKEN de segurança para requisitar toda vez que desejar. Também é informado os parâmetros que podem ser enviados.

Solicitar uma Nova Consulta

https://painel.valideinfoweb.com.br/rdrv2/api/consultar

// https://painel.valideinfoweb.com.br/rdrv2/api/consultar

{
  "message": "É necessário que envie suas credencias para autenticação",
  "result": 0
}

Cria uma nova consulta consumindo do saldo do cliente.

"Valor do parâmetro a ser buscado"

urlNotification "URL que será acionada após a liberação de uma consulta por um operador."

*urlNotification – Não é campo obrigatório

Retorna o Token da consulta solicitado, você poderá usar para acessar o link: https://painel.valideinfoweb.com.br/rdrv2/api/consultas/detalhes

// https://painel.valideinfoweb.com.br/rdrv2/api/consultas/detalhes

{
  "message": "É necessário que envie suas credencias para autenticação",
  "result": 0
}

E informar no BODY, o parâmetro consulta: token-da-consulta, para exibir o resultado, caso deseje consultar mais de uma vez a resposta do JSON.

Atenção: Em caso de alguma oscilação você será notificado através de URL que informar no parâmetro urlNotification.

STATUS 0 – Parâmetro não encontrado (ver modelos txt enviados)

1 – Consulta finalizada

2 – Consulta está aguardando resposta de todos fornecedores ou passando por análise de algum consultor/operador e aguardando liberação

TOKEN Para identificar o insumo da sua consulta, utilize o campo token, ele é único e exclusivo para cada item (insumo) da consulta.

PreviousExemploNextMétodo de Requisição

Last updated