Autenticação

Para realizar requisições em nossa API, é necessário estar autenticado. Após obter suas Chaves de API em sua conta, siga as orientações abaixo para entender o processo de autenticação e integrá-lo corretamente em suas requisições.

Autenticação por Chaves

Na autenticação por chaves, você utilizará seu x-client-id e x-client-secret para validar suas solicitações HTTP.
É obrigatório o uso de autenticação em todas as endpoints disponibilizadas pela API.

POST /api/v1/touch

curl https://api.grupay.app/v1/touch \
    -H "x-client-id: {token}" \
    -H "x-client-secret: {token}"

Mantenha seus tokens sempre protegidos e realize a renovação imediatamente caso suspeite que tenham sido comprometidos.

Onde Obter as Chaves

As chaves de acesso são geradas diretamente por você em Configurações > API. É possível criar ou redefinir novas chaves a qualquer momento.
Após a geração, guarde-as em local seguro, pois não será possível visualizá-las novamente.

Obter Chaves API

Signature

A assinatura é um hash de verificação utilizado para garantir a integridade e autenticidade dos dados. Essa assinatura permite validar se a requisição foi realmente enviada entre você e GruPay.
A assinatura utiliza o mecanismo de HMAC SHA256 juntamente com seu x-client-secret.

Para gerar a chave de assinatura [signature] você pode fazer da seguinte maneira:

PHP

$body = ['message' => 'hello there!' ];
$x_client_secret = 'MTIwZDgwNzY0LTY53GMtNGNjOS1hYuYyLThaOTNjNDc9M2EyZQ==';
$generatedSignature = hash_hmac('sha256', json_encode($body), $x_client_secret);

echo $generatedSignature; // 628f41a77278acaf8fde9394f98fcf67bfb9625704e9a9b031780692b3cd5a1f

O hash de assinatura final será 628f41a77278acaf8fde9394f98fcf67bfb9625704e9a9b031780692b3cd5a1f. Essa assinatura deve ser enviada junto com o cabeçalho signature em todas as requisições. A GruPay fará a validação do seu conteúdo e confirmará a requisição.