Gerar voucher

Esse serviço quando consumido, verifica os parâmetros e fornece um voucher para utilização.

Getvoucher

POST https://sdealhom.soluti.com.br/GVS/webservices/GVSServices.jws?wsdl

Retorna um voucher para utilização, de um lote negociado.

Exemplo: A instituição adquire um lote de 1000 vouchers e vai consumindo até a finalização do lote negociado. Após o consumo total do lote é necessário realizar uma nova aquisição.

Headers

Name	Type	Description
Content-Type*	string	text/xml
SOAPAction*	string	Getvoucher

Request Body

Name	Type	Description
Usuario*	string	Usuário de acesso
Nonce*	string	Número aleatório
Codproduto*	string	Código do produto
Codvenda*	string	Código da venda
Sugestao	string	Sugestão de uso
CpfCnpj	string	Uso restrito para sugestão de uso
Hmac*	string	Cálculo para autenticação
Serial	string	Serial do certificado a ser renovado. O usuário possui um certificado com data de expiração em 20/07/2025. O gestor responsável na instituição informa previamente o serial number do certificado, por exemplo: 11DE465SF.... Regras de validação: Regra 1: Caso o usuário tente importar o voucher utilizando um certificado diferente do serial informado, o processo será bloqueado com erro de validação. Regra 2: A validação do serial somente será aplicada se o campo serial for preenchido. Se não informado, qualquer certificado será aceito.
Email	string	E-mail que receberá o voucher

200: OK

{
    "status": "3",
    "voucher": "000045000101",
    "hmac": "6d394393d56663184b13d158aff0e0726de474e9145742f85b1d643016620a4"
}

Conteúdo dos parâmetros a serem enviados:

1. usuario: Usuário utilizado para acessar a aplicação web.

2. nonce: O número nonce deve ser composto pelo timestamp (Unix Timestamp sem microssegundos) concatenado com uma parte pseudoaleatória de 4 (quatro) números.

3. codproduto: Código do produto no qual o voucher está vinculado. Os códigos dos produtos serão fornecidos pelo SOLUTI no momento da integração.

4. codvenda: Código da venda do seu CRM/ERP. Caso não possua CRM/ERP, envie um número sequencial.

5. sugestao: Nome completo do cliente que irá receber o voucher. Enviar em branco caso não deseja informar a sugestão de uso.

6. cpf-cnpj: CPF/CNPJ do cliente que irá receber o voucher. Enviar em branco caso envie o campo sugestao em branco.

7. restrito: Informe true para que o voucher seja de uso restrito para o cpf-cnpj informado ou informe false para que o voucher não seja de uso restrito.

8. hmac: Valor utilizado para autenticação e validação dos dados enviados. O valor de m é composto pela concatenação de todos os parâmetros anteriores (usuario, nonce, codproduto, codvenda, sugestão, cpf-cnpj, restrito, serial, email). Clique aqui para verificar como é calculado o valor da chave hmac.

9. serial : Será informado o serial do certificado.

10. email : E-mail que receberá o voucher

Todos parâmetros devem ser enviados como string (xsd:string).

Código de exemplo

PHP

<?php

//Usuário utilizado para acessar a aplicação web
$usuario = "central.integracoes";

//Senha de integração - API
$key = "028a858fc98f14e83673ae21e9276281741dbb2996f3652ded1685d34f0803c4";

//Código do produto no qual o voucher está vinculado
$codproduto = "10";

//Código da venda do seu CRM/ERP
$codvenda = "12345678";

//Nome do cliente que irá receber o voucher
$sugestao = "FULANO BELTRANO";

//CPF do cliente irá receber o voucher
$cpfcnpj = "14000656074";

//Informando se será de uso restrido para o CPF informado
$restrito = "true";

//Sera informado o serial do certificado
$serial = '';

//Sera informado o e-mail que recebera o voucher
$email = '[e-mail]';

//Gerando o nonce
$nonce = time() . rand(1000, 9999);

//Montando o hkey
$hkey = $nonce . $key;

//Calculando o hash do hkey
$hash_hkey = hash("sha256", $hkey);

//Contatedando os dados a serem enviados
$m = $usuario . $nonce . $codproduto . $codvenda . $sugestao . $cpfcnpj . $restrito . $serial . $email;

//Calculando o hash do resultado da concatenação do hkey com os dados a serem enviados
$hash_hkey_m = hash("sha256", $hkey . $m);

//Calculado o valor do hmac
$hmac = hash("sha256", $hash_hkey . $hash_hkey_m);

try {
    //URL do S.DEAL de homologação
    $urlhom = "https://sdealhom.soluti.com.br/GVS/webservices/GVSServices.jws?wsdl";

    //Serviço a ser consumido
    $servico = "Getvoucher";
    
    //Criando a chamada do serviço
    $soap = new SoapClient($urlhom);

    //Setando os dados a serem enviados            
    $dados = array(
        'usuario'      => $usuario,
        'nonce'        => $nonce,
        'codproduto'   => $codproduto,
        'codvenda'     => $codvenda, 
        'sugestao'     => $sugestao,
        'cpf-cnpj'     => $cpfcnpj,
        'restrito'     => $restrito,
        'hmac'         => $hmac,
        'serial'       => $serial,
        'Emailcliente' => $email
    );

    $resposta = call_user_func_array(array($soap, $servico), $dados);

    print_r($resposta);

    } catch (Exception $e) {
        echo $e->getMessage();
    } 

Resposta esperada

{
    "status": "10",
    "voucher": "0003a43a6b01",
    "mensagem": "Sugestão de uso informada.",
    "hmac": "92276485921684954cc0002b935fa102718a6d869a0baa9447e4d96534f6c056"
}

Tipos de respostas

status: 0

Retornará esse status quando o cálculo do hmac for inválido.

{
    "status": "0",
    "mensagem": "Autenticação inválida/HMAC inválido."
}

status : 1

Retornará esse status quando não existir voucher alocado para seu usuário com o código do produto informado.

{
    "status": "1",
    "mensagem": "Nenhum voucher encontrado para esse produto.",
    "hmac": "76aa1c5d2b08f67fb50bfb14dd024a2089b0b6a2e92aceecb01cea0a41a6d222"
}

status : 3

Retornará esse status quando for retornado um voucher que está alocado para seu usuário. O voucher será referente ao código do produto informado. Quando informado o código da venda, primeiramente será verificado se já existe algum voucher alocado para seu usuário com o código da venda informado e que não foi utilizado, se sim, será retornado o voucher, se não, será retornado um novo voucher e vinculado ele o código da venda informado.

{
    "status": "3",
    "voucher": "000045000101",
    "hmac": "6d394393d56663184b13d158aff0e0726cde474e9145742f85b1d643016620a4"
}

status : 4

Retornará esse status quando não tiver sido informado o nome do cliente para a sugestão de uso.

{
    "status": "4",
    "mensagem": "Informe a sugestão de uso.",
    "hmac": "53ebde463806f82215dbb09ba7041b0c5a5483209a05d8a9f13b4052f22c2dbb"
}

status : 5

Retornará esse status quando não tiver sido informado o CPF ou CNPJ do cliente para a sugestão de uso.

{
    "status": "5",
    "mensagem": "Informe o CPF/CNPJ da sugestão de uso.",
    "hmac": "191a54a8c83679112d5176076e7f5dd88b288e015a939ed8c3d475f1ebd2cc2d"
}

status : 6

Retornará esse status quando não tiver sido informado se o voucher será de uso restrito ou não.

{
    "status": "6",
    "mensagem": "Informe se o voucher será de uso restrito ou não.",
    "hmac": "67f97bd72ddb54b1b12aa9d5ae3b8088cda89cbff9799f73315878c4ccbb0681"
}

status : 7

Retornará esse status quando tiver sido informado um valor diferente de true ou false.

{
    "status": "7",
    "mensagem": "Informe true para voucher restrito ou false para não restrito.",
    "hmac": "88dc9e37eeead6ba8e304ddc33d640cfd8cd3ca17571bcdc4b8a24e2df0b7bda"
}

status : 8

Retornará esse status quando tiver sido informado um CPF inválido.

{
    "status": "8",
    "mensagem": "O CPF informado é inválido.",
    "hmac": "ab655bfc9c32117b89ec8db77023664a8304ae7b9cce1ea775c82d07921c2cdd"
}

status : 9

Retornará esse status quando tiver sido informado um CNPJ inválido.

{
    "status": "9",
    "mensagem": "O CNPJ informado é inválido.",
    "hmac": "f1fcc99abee4614b1311778ae5c39cf2c78f1084658d5fad6e80d772ce7352bf"
}

status : 10

Retornará esse status quando for retornado um voucher disponível para utilização e feito o registro da sugestão de uso informada. Se todos seus vouchers no banco estiverem vinculado a outro código de venda mas algum deles estiver sem sugestão de uso e que não tenha sido utilizado, é alterado o código da venda para o novo código da venda informado.

{
    "status": "10",
    "voucher": "000045000101",
    "mensagem": "Sugestão de uso informada.",
    "hmac": "88a48cd7abaf4ac3246e28941d6788ba28e0fd8df979c1d39d8a6aa323402a35"
}

status : 11

Retornará esse status quando o voucher solicitado estiver com sugestão de uso para outro CPF/CNPJ.

{
    "status": "11",
    "mensagem": "Voucher com sugestão de uso para outro cliente.",
    "hmac": "f96e758aebf8f07fe7d2802a6411352aef06fee60fed473f711333018ea5f031"
}