Introdução

KinexPay - Gateway API

A nossa API foi projetada para oferecer uma integração simples e eficiente, seguindo os padrões REST, o que garante uma experiência ágil e compatível com diversos sistemas. Todas as respostas são fornecidas no formato JSON, proporcionando uma estrutura clara e fácil de utilizar para os desenvolvedores.

Autenticação

Método de Autenticação: Authorization Basic

Para acessar a API, utilize Authorization Basic com as seguintes credenciais:

• Username: Secret Key (Chave Secreta)
• Password: Company ID

Como Obter as Credenciais

1. Acesse o painel do gateway
2. Navegue até Integrações → Chaves de API
3. Copie a Secret Key (será usada como username)
4. Copie o Company ID (será usado como password)

Implementação da Autenticação

Ao realizar requisições, inclua as credenciais no cabeçalho HTTP Authorization usando Basic Authentication:

Formato do Header:

Authorization: Basic {base64_encoded_credentials}

Onde {base64_encoded_credentials} é a codificação Base64 da string {SECRET_KEY}:{COMPANY_ID}.

Exemplo em Node.js:

TypeScript

const secretKey = "sua_secret_key_aqui";
const companyId = "seu_company_id_aqui";

const credentials = Buffer.from(`${secretKey}:${companyId}`).toString("base64");

const options = {
    method: "POST",
    url: "https://api.kinexpay.com.br/functions/v1/transactions",
    headers: {
        "Authorization": `Basic ${credentials}`,
        "Content-Type": "application/json"
    },
};

Exemplo em PHP:

PHP

<?php
$secretKey = "sua_secret_key_aqui";
$companyId = "seu_company_id_aqui";

$credentials = base64_encode($secretKey . ':' . $companyId);

$headers = [
    'Authorization: Basic ' . $credentials,
    'Content-Type: application/json'
];

$data = json_encode([
    "data" => "example"
]);

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => "https://api.kinexpay.com.br/functions/v1/transactions",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => $data,
    CURLOPT_HTTPHEADER => $headers
]);

$response = curl_exec($curl);
$httpCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

if ($httpCode === 200) {
    $result = json_decode($response, true);
    // Processar resposta
} else {
    // Tratar erro
    echo "Erro na requisição: " . $httpCode;
}
?>

Exemplo em cURL:

Bash

curl -X POST \
  https://api.kinexpay.com.br/functions/v1/transactions \
  -H "Authorization: Basic $(echo -n 'SECRET_KEY:COMPANY_ID' | base64)" \
  -H "Content-Type: application/json" \
  -d '{"data": "example"}'

Tratamento de Erros de Autenticação

Em caso de credenciais inválidas, a API retornará:

• Status Code: 401 Unauthorized
• Response:

Text

Unauthorized

Endpoints Base

A URL base da API é:

https://api.kinexpay.com.br/functions/v1

Recursos Disponíveis

Nossa API oferece os seguintes recursos principais:

• Transações: Gerenciamento completo de transações (criação, listagem, busca e atualização)

Para mais detalhes sobre cada endpoint, consulte a documentação completa da API.

Considerações de Segurança

• Nunca exponha suas credenciais (Secret Key e Company ID) em código cliente
• Mantenha suas credenciais seguras e não as compartilhe
• Use HTTPS sempre para todas as requisições