Início Rápido

Veja abaixo uma demonstração prática de como realizar sua primeira requisição à nossa API, seguindo a ordem correta dos passos. Este guia foi elaborado para facilitar sua integração inicial, apresentando exemplos práticos e claros.

Este exemplo considera que você já possui suas chaves de API em mãos como descrito na seção anterior.

Headers [Cabeçalhos] Para efetuar requisições à nossa API, você precisará incluir os seguintes cabeçalhos.

Nome

Accept *

Tipo

string

Descrição

Aceitar respostas em formato JSON. Ex: application/json
Nome

Content-Type *

Tipo

string

Descrição

Enviar requisições em formato JSON. Ex: application/json
Nome

x-client-id *

Tipo

string

Descrição

Chave ID do cliente.
Nome

x-client-secret *

Tipo

string

Descrição

Chave secreta do cliente.
Nome

signature *

Tipo

string

Descrição

Hash de verificação utilizado para garantir a integridade e autenticidade dos dados. Essa assinatura permite validar se a requisição foi realmente enviada por você.

GET /api/v1/touch

$client = new Client();

$headers = [
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
    'x-client-id' => '20d80764-69da-4ce9-ac32-2c91c4772a2e',
    'x-client-secret' => 'MTIwZDgwNzY0LTY53GMtNGNjOS1hYuYyLThaOTNjNDc9M2EyZQ==',
    'signature' => '628f41a77278acaf8fde9394f98fcf67bfb9625704e9a9b031780692b3cd5a1f'
];

$body = '{
    "message": "hello there!"
}';

$request = new Request('GET', 'https://api.grupay.app/v1/touch', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

200 Sucesso

{
    "success": true,
    "message": "You are authorized to run this endpoint"
}

401 Não Autorizado

{
    "success": false,
    "message": "Unauthorized"
}