Skip to main content

Visão Geral

A API StylePay utiliza um sistema de autenticação baseado em credenciais via headers HTTP customizados. Todas as requisições à API devem incluir suas credenciais de autenticação.

Credenciais de API

Para acessar a API, você precisará de duas credenciais:
stpi
string
required
Client ID - Identificador único da sua aplicação
stps
string
required
Client Secret - Chave secreta para autenticação
Mantenha suas credenciais seguras! Nunca compartilhe seu Client Secret ou o exponha em código cliente (frontend, aplicativos móveis, etc.).

Como Obter suas Credenciais

  1. Acesse o painel de administração StylePay
  2. Navegue até a seção de Configurações de API
  3. Gere ou copie suas credenciais Client ID (stpi) e Client Secret (stps)
Se você ainda não possui credenciais, entre em contato com o suporte StylePay para criar uma conta de desenvolvedor.

Como Autenticar

Inclua suas credenciais no header de todas as requisições HTTP:
curl --location 'https://api.stylepay.com.br/api/v1/endpoint' \
--header 'stpi: seu_client_id' \
--header 'stps: seu_client_secret' \
--header 'Content-Type: application/json'

Respostas de Autenticação

Autenticação Bem-Sucedida

Quando suas credenciais são válidas, a API processará sua requisição normalmente e retornará a resposta esperada do endpoint.

Falha na Autenticação

Se as credenciais forem inválidas ou estiverem ausentes, você receberá um erro 401:
{
  "statusCode": 401,
  "message": "Invalid credentials",
  "error": "Unauthorized"
}

Melhores Práticas de Segurança

  • Use variáveis de ambiente para armazenar suas credenciais
  • Nunca faça commit de credenciais no controle de versão (Git)
  • Use ferramentas de gerenciamento de secrets em produção (AWS Secrets Manager, Azure Key Vault, etc.)
  • Sempre use HTTPS para comunicação com a API
  • Implemente rate limiting em sua aplicação
  • Monitore o uso da API para detectar atividades suspeitas
  • Rotacione suas credenciais periodicamente
  • Revogue imediatamente credenciais comprometidas
  • Mantenha credenciais diferentes para ambientes de desenvolvimento e produção
  • Use credenciais de sandbox/teste para desenvolvimento
  • Nunca use credenciais de produção em ambientes de teste
  • Limite o acesso às credenciais apenas para membros autorizados da equipe

Ambientes

A API StylePay está disponível nos seguintes ambientes:
AmbienteBase URLUso
Produçãohttps://api.stylepay.com.brTransações reais
Sandboxhttps://sandbox-api.stylepay.com.brTestes e desenvolvimento
Utilize o ambiente de Sandbox para testar sua integração antes de ir para produção. As credenciais são diferentes entre os ambientes.

Exemplo Completo

Aqui está um exemplo completo de como fazer uma requisição autenticada:
// Configuração (use variáveis de ambiente)
const CLIENT_ID = process.env.STYLEPAY_CLIENT_ID;
const CLIENT_SECRET = process.env.STYLEPAY_CLIENT_SECRET;
const BASE_URL = 'https://api.stylepay.com.br';

// Função auxiliar para fazer requisições autenticadas
async function stylePayRequest(endpoint, method = 'GET', body = null) {
  const options = {
    method,
    headers: {
      'stpi': CLIENT_ID,
      'stps': CLIENT_SECRET,
      'Content-Type': 'application/json'
    }
  };

  if (body) {
    options.body = JSON.stringify(body);
  }

  try {
    const response = await fetch(`${BASE_URL}${endpoint}`, options);
    
    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }
    
    return await response.json();
  } catch (error) {
    console.error('Erro na requisição:', error);
    throw error;
  }
}

// Exemplo de uso
async function consultarSaldo() {
  const saldo = await stylePayRequest('/api/v1/wallet/balance');
  console.log('Saldo:', saldo.balance);
}

Suporte

Se você tiver problemas com autenticação ou precisar de novas credenciais: