Sorry, you need to enable JavaScript to visit this website.
Pular para o conteúdo principal

Entendendo a Documentação das APIs do Santander

Criado em 09/11/2023 às 17:45 por Felipe Hanzava de Oliveira

As APIs (Interfaces de Programação de Aplicativos) estão cada vez mais presentes no mundo digital, oferecendo soluções que facilitam a comunicação e integração entre diferentes sistemas e aplicações. Uma dessas APIs é a API Pix do Santander, que permite a criação e gestão de chaves Pix para realização de pagamentos e transferências instantâneas.

Neste artigo, vamos explorar a documentação da API Pix do Santander, abordando as suas principais funcionalidades e como utilizá-las. Embora o foco seja na API Pix do Santander, as informações aqui presentes podem ser aplicadas em outras APIs, uma vez que, em geral, seguem um padrão de documentação semelhante.

Desenvolvimento:  

No desenvolvimento de aplicações que utilizam APIs, a documentação é uma ferramenta indispensável, pois fornece informações detalhadas sobre as funcionalidades disponíveis, como acessá-las e como utilizá-las. No caso da API Pix do Santander, a documentação é organizada em seções, que abrangem desde a autenticação até a criação e gerenciamento de chaves Pix.

Na seção de autenticação, a documentação da API Pix do Santander apresenta os detalhes de como realizar a sua autenticação e aplicação, utilizando o protocolo OAuth2. Além disso, a documentação traz informações sobre os endpoints disponíveis, que permitem realizar as operações de criação e gestão de chaves Pix.

Uma das principais funcionalidades da API Pix do Santander é a criação de chaves Pix, de forma quena seção dedicada a essa funcionalidade, a documentação apresenta os parâmetros necessários para a criação de uma nova chave Pix, como utilizando informações CPF, CNPJ, telefone, e-mail, etc.). 

Além da criação de chaves Pix, a API Pix do Santander também permite o gerenciamento dessas chaves para realizar: (i) a exclusões; (ii) consultas de informações; (iii) listagem das chaves cadastradas e (iv) alterações de dados.

Para facilitar a sua utilização, a documentação apresenta exemplos de requisições em diferentes linguagens de programação, como Java, Node.js, Python, Ruby e C#. Esses exemplos são uma excelente referência para desenvolvedores que estão iniciando no uso da API Pix do Santander ou que desejam implementar a API em uma nova linguagem de programação.

Entendendo a Documentação    

  • Visão geral da página de documentação

Ao acessar a página de documentação da API Pix do Santander, você encontrará uma visão geral dos endpoints disponíveis para a realização de transações Pix. Os endpoints são as URLs que você vai utilizar para se comunicar com a API e realizar as operações desejadas. 

  • Endpoints disponíveis

Na seção de endpoints, você encontrará a lista completa de endpoints disponíveis na API Pix do Santander. Cada endpoint é uma URL que pode ser utilizada para realizar uma operação específica, como criar uma chave Pix, consultar um Pix recebido ou cancelar um Pix.

  • Parâmetros de entrada

Cada endpoint possui uma lista de parâmetros de entrada que devem ser enviados junto com a requisição. Esses parâmetros podem ser obrigatórios ou opcionais, e variam de acordo com a operação desejada.

  • Body

O body é a parte da requisição que contém os dados da transação Pix. Esses dados podem incluir informações como o valor da transação, a chave Pix do destinatário, a descrição da transação, entre outros. O body é enviado em formato JSON e deve seguir a estrutura definida na documentação da API.

  • Identificador de transação

O identificador de transação é um parâmetro obrigatório que deve ser enviado junto com a requisição para identificar a transação Pix. Esse identificador deve ser único para cada transação e pode ser utilizado posteriormente para consultar o status da transação ou realizar outras operações relacionadas a ela.

  • Exemplos de código

Ao lado de cada endpoint, você encontrará exemplos de código em várias linguagens de programação, como Java, Python e JavaScript. Esses exemplos mostram como utilizar a API Pix do Santander em sua aplicação, incluindo como enviar os parâmetros de entrada e o body da requisição.

  • Código de exemplo implementado

Abaixo, vamos mostrar um exemplo de código implementado em Java para criar uma chave Pix utilizando a API Pix do Santander:

import java.io.BufferedReader;
                                import java.io.InputStreamReader;
                                import java.io.OutputStreamWriter;
                                import java.net.HttpURLConnection;
                                import java.net.URL;
                                public class CriarChavePix {
                                public static void main(String[] args) throws Exception {
                                // URL da API Pix do Santander
                                URL url = new URL("https://api.santander.com.br/pix/v1/keys");
                                // Cabeçalho da requisição
                                String chaveApi = "sua_chave_api_aqui";
                                String contentType = "application/json";
                                // Dados da chave Pix a ser criada
                                String body = "{\n" +
                                       "    \"keyType\": \"PHONE\",\n" +
                                       "    \"key\": \"+5511987654321\",\n" +
                                       "    \"bankAccount\": {\n" +
                                       "        \"participant\": \"60701190\",\n" +
                                       "        \"branch\": \"0001\",\n" +
                                       "        \"accountNumber\": \"12345678\",\n" +
                                       "        \"accountType\": \"CACC\"\n" +
                                       "    },\n" +
                                       "    \"owner\": {\n" +
                                       "        \"name\": \"João Silva\"\n" +
                                       "    }\n" +
                                       "}";
                                            // Conexão HTTP
                                HttpURLConnection connection = (HttpURLConnection) url.openConnection();
                                connection.setRequestMethod("POST");
                                connection.setRequestProperty("Authorization", "Bearer " + chaveApi);
                                connection.setRequestProperty("Content-Type", contentType);
                                connection.setDoOutput(true);
                                // Envio da requisição
                                OutputStreamWriter writer = new  OutputStreamWriter(connection.getOutputStream());
                                            writer.write(body);
                                            writer.flush();
                                            writer.close();
                                // Leitura da resposta
                                BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()));
                                            String line;
                                            StringBuilder response = new StringBuilder();
                                            while ((line = reader.readLine()) != null) {        
                                 
                                                response.append(line);
                                            }
                                            reader.close();
                                // Impressão da resposta
                                            System.out.println(response.toString());
                                        }
                                    }

Este exemplo utiliza a linguagem de programação Java e a biblioteca HttpURLConnection para realizar a requisição à API Pix do Santander. O código envia uma requisição POST para o endpoint de criação de chave Pix, com os parâmetros de entrada e o body necessários. A resposta da API é lida e impressa no console.

É importante lembrar que este é apenas um exemplo de implementação e que o código pode variar de acordo com a linguagem de programação e as bibliotecas utilizadas em sua aplicação. Na página de documentação da API Pix do Santander, você encontrará exemplos de código em diversas linguagens, incluindo as mais atuais e comuns no mercado, como Node.js, Python, Ruby e C#.

Conclusão:  

Neste artigo, apresentamos uma visão geral da API Pix do Santander e explicamos cada parte da página de documentação, mostrando como utilizar os endpoints disponíveis, enviar parâmetros de entrada e body, e utilizar o identificador de transação para realizar operações relacionadas à transação Pix. Além disso, mostramos um exemplo de código implementado em Java para criar uma chave Pix utilizando a API do Santander.

A API Pix do Santander é uma ferramenta poderosa para integrar a funcionalidade de Pix em suas aplicações e sistemas, permitindo que seus clientes realizem transações financeiras de forma simples e segura. Com as informações apresentadas neste artigo, você estará pronto para começar a utilizar a API Pix do Santander em sua aplicação.