Pular para o conteúdo principal

Autenticação com a API

A autenticação é o primeiro passo para integrar com a FastPay API. Este guia irá mostrar como obter e usar suas credenciais de forma segura.

Visão Geral

Nossa API utiliza autenticação Basic Auth com API keys seguras. Todas as requisições devem incluir o header de autorização para serem processadas.

Características de Segurança:

  • ✅ API keys únicas por merchant
  • ✅ HTTPS obrigatório em todas as requisições
  • ✅ Autenticação baseada em padrões da indústria

Obtendo suas Credenciais

Passo 1: Acesse o Painel

  1. Navegue até o painel da FastPay
  2. Faça login em sua conta
  3. Acesse Configurações
  4. Selecione Chave de API

Passo 2: Gere sua API Key

Atenção: Guarde sua API key em um local seguro! Por motivos de segurança, ela será exibida apenas uma vez.

# Exemplo de API key
sk_9a8s7d6f5g4h3j2k1l0z9x8c7v6b5n4m3

Como Usar

Header de Autenticação

# Formato: SUA_API_KEY: convertido para Base64
Authorization: Basic <token_base64>

Exemplo prático:

# Se sua API key for: sk_abc123
# Combine: sk_abc123:
# Resultado em Base64: c2tfYWJjMTIzOg==
# Header: Authorization: Basic c2tfYWJjMTIzOg==

Exemplos de Implementação

JavaScript (Node.js)

const axios = require('axios');

const apiKey = 'sk_9a8s7d6f5g4h3j2k1l0z9x8c7v6b5n4m3';
const credentials = Buffer.from(`${apiKey}:`).toString('base64');

axios.get('https://api-global.fastpaybrasil.com/v1/payment-methods', {
headers: {
Authorization: `Basic ${credentials}`,
}
});

cURL

curl -X GET "https://api-global.fastpaybrasil.com/v1/payment-methods" \
-H "Authorization: Basic $(echo -n 'sua_api_key:' | base64)"

PHP

<?php
$apiKey = 'sk_9a8s7d6f5g4h3j2k1l0z9x8c7v6b5n4m3';
$credentials = base64_encode("$apiKey:");

$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://api-global.fastpaybrasil.com/v1/payment-methods',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Basic ' . $credentials,
'Content-Type: application/json'
]
]);

$response = curl_exec($curl);
curl_close($curl);
?>

Python

import requests
import base64

api_key = 'sk_9a8s7d6f5g4h3j2k1l0z9x8c7v6b5n4m3'
credentials = base64.b64encode(f'{api_key}:'.encode()).decode()

headers = {
'Authorization': f'Basic {credentials}',
'Content-Type': 'application/json'
}

response = requests.get(
'https://api-global.fastpaybrasil.com/v1/payment-methods',
headers=headers
)

Boas Práticas de Segurança

1. Armazenamento Seguro

Nunca faça isso:

// INSEGURO - API key exposta no código
const apiKey = 'sk_9a8s7d6f5g4h3j2k1l0z9x8c7v6b5n4m3';

Faça isso:

// SEGURO - API key em variável de ambiente
const apiKey = process.env.FASTPAY_API_KEY;

2. Variáveis de Ambiente

Configure suas variáveis de ambiente:

# Configure sua variável de ambiente
export FASTPAY_API_URL="https://api-global.fastpaybrasil.com"
export FASTPAY_API_KEY="sua_api_key_aqui"

3. Diretrizes Gerais

  • Nunca exponha sua API key em código client-side
  • Use variáveis de ambiente para armazenar chaves
  • Rotacione chaves periodicamente
  • Use HTTPS sempre para comunicação
  • Monitore logs de acesso para atividades suspeitas

Tratamento de Erros

Erro 401 - Não Autorizado

{
"message": "Unauthorized",
"statusCode": 401
}

Possíveis causas:

  • API key inválida ou expirada
  • Header de autorização ausente
  • Formato incorreto do header

Erro 403 - Proibido

{
"message": "Forbidden",
"statusCode": 403
}

Possíveis causas:

  • API key sem permissões para o recurso
  • Acesso negado para a operação solicitada

Próximos Passos

Agora que você está autenticado, explore:


Para dúvidas sobre autenticação, consulte nosso site oficial.