Descrever o modo de utilização da API / Web Services da WL Valideinfo.
Segurança
Sempre utiliza a porta segura HTTPS para realizar suas consultas.
Desenvolvimento
A linguagem de desenvolvimento desta API foi em PHP utilizando os métodos seguros de SOAP com saída em JSON.
Endereço da 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
}
Endereço da Resposta
Após ser enviado os dados obrigatórios para requisitar a consulta, em caso de oscilação da resposta total (quando se refere a consultas complexas) o cliente poderá informar uma url de retorno no momento do pedido da consulta, no qual após ser finalizada 100% nossa plataforma executará o local (urlNotification) do cliente informado para assim atualizar as informações.
Para Testar a integração
Nós utilizamos o SOAPMAN que é uma extensão do Google Chrome ou pode ser instalado direto no seu computador para testar e enviar os dados como headers, parâmetros e outras informações obrigatórias para realizar sua consulta.
