Autenticação

A autenticação para o serviço consulta-dados-solicitacao utilizará o protocolo HMAC. Objetivo: permitir de forma segura a comunicação entre o Cliente e o Servidor.

Nonce

O número nonce deve ser composto pelo timestamp (Unix Timestamp sem microssegundos).

HMAC

O protocolo HMAC prevê comunicação para mensagens imunes a ataques de replay.

O Servidor define o algoritmo de hash H()a ser utilizado para cálculo do HMAC. Recomendamos SHA256 ou superior.

Cliente e Servidor devem utilizar a mesma chave keypara o cálculo do HMAC.

A key utilizada será fornecida pela Soluti durante a etapa de integração.

O HMAC é calculado da seguinte forma:

$$hmac=H(H(hkey)∣∣H(hkey∣∣ds))$$

H() : Algoritmo de hash (sha256) hkey : Chave utilizada para o cálculo || : Concatenação de strings ds : Assinatura dos dados

A chave hkey é definida da seguinte forma:

$$hkey=nonce║key$$

A chave ds é definida da seguinte forma:

$$ds=(method∣∣uri∣∣m)$$

ds : Assinatura dos dados method: Método a ser utilizado(POST) uri : <base_url>/webservice-api/consulta-dados-solicitacao m : Mensagem em formato JSON sendo a chave o nome do parâmetro a ser enviado

A base_url é o link de acesso ao Sistema da AR. Exemplo: https://arsolutihom.acsoluti.com.br

Pesquisando pelo CPF do Cliente:

Exemplo de m em formato JSON

{
    "dataInicial": "2020-11-12",
    "cpf": [
        "54524213007",
        "11252589000",
        "87183102068"
    ]
}

Pesquisando pelo CNPJ do Cliente:

Exemplo de m em formato JSON

{
    "dataInicial": "2020-11-12",
    "cnpj": [
        "62044911000178",
        "2054708000150"
    ]
}

Pesquisando pelo Código da Solicitação:

Exemplo de m em formato JSON

{
    "dataInicial": "2020-11-12",
    "solicitacao": [
        "113D21072064441A",
        "113D2107205FEC7E",
        "113D201211402E2D"
    ]
}

Pesquisando pelo número do Pedido de Venda/Voucher do Cliente:

Exemplo de m em formato JSON

{
    "dataInicial": "2020-11-12",
    "codigo_erp": [
        "0003055e3310",
        "0003d25e3910",
        "000354491734"
    ]
}

Exemplo de comunicação Hmac

Cáculo do HMAC em PHP

$baseUrl = "https://arsolutihom.acsoluti.com.br";
$uri = "{$baseUrl}/webservice-api/consulta-dados-solicitacao-v2";
$method = 'POST';
$hmacVersion = 1;
$clientId = 0;

$mensagem = array(
    "dataInicial" => "2020-11-12",
    "cpf" => array(
        "54524213007",
        "11252589000",
        "87183102068"
    )
);

$m = json_encode($mensagem);

$ds = $method . $uri . $m;
$key = "CHAVESECRETAAPI";
$nonce = time();
$hkey = $nonce . $key;
$hmac = hash('sha256', hash('sha256', $hkey) . hash('sha256', $hkey . $ds));

Header

Preparando o conteúdo a ser enviado no Header da requisição:

$header = [
    'HMAC-Authentication' => $hmacVersion . ':' . $clientId . ':' . $nonce . ':' . $hmac
];

O valor da variável $hmacVersion corresponde a versão do HMAC utilizada.

Atualmente estamos na versão 1.

O valor da variável $clientId corresponde ao ID do Cliente de Integração.

Por padrão será 0.

Serviço