Protocolos de segurança#
A API da Pluggy exige o uso de HTTPS TLSv1.2 ou versões superiores por razões de segurança. Outros pedidos de versão TLS serão rejeitados. Toda a comunicação deve ser feita em HTTPS.
Verbos da API e Protocolos#
A API da Pluggy é uma API RESTful baseada em solicitações e respostas JSON, portanto, todas as solicitações devem ter o cabeçalho Content-Type definido como application/json.
Seguimos os padrões RESTful e todos os verbos correspondem à sua ação específica para o recurso com o qual você estará se comunicando.
Campos de resposta da API
Evoluímos nossa API de uma maneira não destrutiva, adicionando novos campos às respostas de nossos endpoints. Isso torna mais simples, uma vez que não há mecanismos complicados de versionamento, mas também significa que seu cliente HTTP deve suportar o recebimento de campos desconhecidos em uma resposta e ignorá-los. Na maioria das bibliotecas, isso é suportado por padrão, mas, por favor, revise seu caso particular para verificar se isso está configurado corretamente.
Ambiente#
Nosso ambiente de produção está aceitando solicitações no seguinte host:
https://api.pluggy.ai
Paginação#
Algumas respostas da Pluggy podem gerar uma grande quantidade de dados, nos quais o tamanho da resposta é limitado e dividido em páginas.
Por exemplo, se você fizer uma solicitação para /transaction?accountId={ACCOUNT_ID}, você receberá um objeto como:
{
"total": 200,
"totalPages": 15,
"results": [],
"page": 1
}- total: o tamanho dos dados da solicitação
- totalPages: o número total de páginas que abrangem todos os registros disponíveis
- results: o conteúdo da página atual
- page: o número da página atual
Por exemplo, /transaction?accountId={ACCOUNT_ID}&page=2 é a segunda página dos resultados das transações.
Ao recuperar /transaction?accountId={ACCOUNT_ID}, em seguida, /transaction?accountId={ACCOUNT_ID}&page=2, e assim por diante, você pode acessar todos os dados disponíveis, uma página de cada vez.
Resumindo, para obter todos os dados de um endpoint paginado, após sua primeira solicitação, você deve iterar tantas vezes quanto totalPages, fazendo uma nova solicitação e alterando o parâmetro de consulta page.