Skip to main content

​
O que são os SDKs da Upay?

Os SDKs (Software Development Kits) da Upay são bibliotecas oficiais que simplificam a comunicação com nossa API. Eles oferecem uma interface amigável e específica para cada linguagem, permitindo que você integre rapidamente PIX, cartão e boleto ao seu sistema.

Benefícios de usar nossos SDKs

  • Integração simplificada: Funções prontas para todos os endpoints da API
  • Tipagem forte: Interfaces e types completos em linguagens com suporte a tipos
  • Tratamento de erros: Gerenciamento automático dos casos de erro mais comuns
  • Validação de webhooks: Utilitários prontos para verificar assinaturas HMAC-SHA256
  • Menor curva de aprendizado: Sem necessidade de conhecer todos os detalhes HTTP da API

​
SDKs Disponíveis

Oferecemos SDKs oficiais para as principais linguagens de backend. Escolha o que melhor se adapta à sua stack:

Node.js / TypeScript

SDK oficial para Node.js 18+, compatível com TypeScript, ESM e edge runtimes.

Python

SDK oficial para Python 3.8+, com type hints e suporte a frameworks como Flask e Django.

PHP

SDK oficial para PHP 8.1+, disponível via Composer e sem dependências externas além de cURL.

Java

SDK oficial para Java 17+, compatível com Spring Boot e qualquer projeto Maven/Gradle.

​
Instalação Rápida

Os SDKs estão disponíveis no GitHub e ainda não foram publicados nos registros públicos de pacotes (npm, PyPI, Packagist, Maven Central). Consulte a página de cada SDK para instruções de instalação via GitHub.
npm install github:anthonymengottii/upay-nodejs-sdk

​
Primeiros Passos

Todos os SDKs seguem o mesmo padrão: instancie o cliente com sua API Key e acesse os recursos diretamente. 
import UpayClient from '@upay/upay-js';

const upay = new UpayClient({ apiKey: process.env.UPAY_API_KEY });

const link = await upay.paymentLinks.create({
  title: 'Produto Premium',
  amountCents: 9900,
});
console.log('Checkout:', link.url);

​
Perguntas Frequentes

Acesse o Dashboard → Configurações → Credenciais de API e gere uma nova chave. Nunca exponha sua API Key no código-fonte — use variáveis de ambiente e adicione .env ao .gitignore.
Sim. Todos os SDKs aceitam um parâmetro baseUrl opcional no construtor, permitindo apontar para qualquer ambiente. Use sua chave de API do ambiente desejado (desenvolvimento ou produção).
Todos os SDKs incluem um método verifyWebhookSignature(payload, signature, secret) que verifica a assinatura HMAC-SHA256 automaticamente. Consulte a página do SDK da sua linguagem para o exemplo completo.
Abra uma issue no repositório GitHub do SDK específico. Nossa equipe está sempre atenta para corrigir bugs e melhorar as bibliotecas. Você também pode entrar em contato pelo e-mail suporte@upaybr.com.
Entre em contato pelo e-mail suporte@upaybr.com informando qual linguagem você precisa. Nossa equipe avaliará a demanda para incluir na roadmap.

​
Recursos Adicionais

Autenticação

Como gerar e usar suas credenciais de API.

Webhooks

Configure notificações automáticas para eventos de pagamento.

Referência da API

Documentação completa de todos os endpoints.

Changelog

Histórico de versões e atualizações.

Precisa de ajuda com a integração?

Nossa equipe está disponível para ajudar. Entre em contato: suporte@upaybr.com