SDKs
Integre dados financeiros do mercado brasileiro às suas aplicações usando os SDKs oficiais da Partnr para Python e JavaScript/TypeScript.
Os SDKs oferecem um cliente autenticado, métodos organizados por recurso, estruturas de dados tipadas e tratamento consistente de respostas e erros. Assim, sua equipe pode consultar a Partnr API sem precisar construir manualmente URLs, headers, parâmetros e requisições HTTP.
As SDKs são destinadas a ambientes server-side (backend). Não utilize em frontend/browser, pois a chave de API não deve ser exposta. Para uso em apps web/mobile, crie um proxy no seu backend.
Por que usar os SDKs oficiais da Partnr?
Os SDKs foram desenvolvidos para simplificar integrações com dados financeiros brasileiros e oferecer uma experiência mais consistente em produção.
Entre os principais benefícios estão:
- Autenticação centralizada com a sua API key
- Métodos organizados por recurso da Partnr API
- Modelos e respostas tipadas
- Autocomplete e validação durante o desenvolvimento
- Tratamento padronizado de erros
- Retry automático para falhas transitórias
- Configuração de timeout e número máximo de tentativas
- Menos código repetitivo para montar requisições HTTP
- Atualizações alinhadas à evolução da Partnr API
O uso de um SDK também reduz o risco de inconsistências entre diferentes partes da aplicação, já que autenticação, parâmetros e respostas seguem os mesmos padrões.
Linguagens disponíveis
SDK Python
O SDK Python da Partnr é indicado para aplicações backend, pipelines de dados, análises financeiras, automações, notebooks, serviços internos e projetos de inteligência artificial.
É compatível com Python 3.9 ou superior e pode ser instalado com pip, Poetry ou uv.
Consulte a documentação completa do SDK Python.
SDK JavaScript e TypeScript
O SDK JavaScript/TypeScript é recomendado para APIs, aplicações Node.js, microsserviços, plataformas financeiras e outros sistemas executados em ambientes server-side.
É compatível com Node.js 18 ou superior e pode ser instalado com npm, Yarn ou pnpm.
Consulte a documentação completa do SDK JavaScript/TypeScript.
SDK, cURL ou MCP: qual utilizar?
A Partnr oferece diferentes formas de integração. A melhor escolha depende do tipo de aplicação que você está construindo.
| Forma de integração | Quando utilizar |
|---|---|
| SDK | Aplicações em produção, serviços backend, pipelines e sistemas que precisam de tipagem e métodos prontos |
| cURL ou REST | Testes rápidos, validação de endpoints, depuração e integrações em linguagens ainda não atendidas pelos SDKs |
| MCP | Agentes e aplicações de inteligência artificial que precisam descobrir e consultar ferramentas durante uma tarefa |
Para a maioria das aplicações backend em produção, recomendamos utilizar um dos SDKs oficiais.
Para testar a API antes de instalar uma biblioteca, você pode começar com uma requisição cURL.
Para conectar os dados da Partnr a agentes de IA compatíveis com Model Context Protocol, consulte a documentação do MCP.
Boas práticas de segurança
As requisições à Partnr API são autenticadas por meio de uma API key. Essa credencial deve ser tratada como um segredo.
Ao utilizar os SDKs:
- Armazene a chave em uma variável de ambiente ou gerenciador de segredos
- Não escreva a chave diretamente no código-fonte
- Não publique credenciais em repositórios Git
- Não envie a API key para o frontend
- Não registre a chave em logs
- Utilize os SDKs somente em ambientes server-side
- Faça a rotação da credencial caso ela seja exposta
Em aplicações web ou mobile, o frontend deve se comunicar com um serviço controlado pelo seu backend. Esse serviço será responsável por autenticar e encaminhar as consultas à Partnr API.