Esta API implementa serviços de integração com o modelo de dados dos sistemas da APPDO.
Se essa é a sua primeira integração com o a APPDO, sugerimos iniciar pelo passo a passo abaixo:
O primeiro e importante passo para conseguirmos uma rápida integração é acessar e ler a documentação disponível para a API do serviço que você deseja consumir.
Acesse o link Referências da API no menu superior da página.
A documentação detém informações imprescindíveis sobre o funcionamento de cada API, características do desenvolvimento necessário à integração e detalhes importantes do serviço a ser integrado. Esse conhecimento será determinante para que sua empresa ou o seu cliente usufrua da melhor experiência possível com os nossos serviços.
No menu disponível à esquerda estão disponíveis as informações necessárias para que você compreenda todo o processo de integração (um passo a passo semelhante a este que está lendo), aspectos de segurança necessários às integrações por API, a geração de credenciais que asseguram a troca de dados e a integridade dos testes das aplicações, assim como materiais referentes ao serviço consumido. Muito em breve disponibilizaremos novas APIs e outros documentos.
Após a leitura da documentação, sugerimos iniciar o desenvolvimento da integração.
Solicite a APPDO a criação da sua aplicação em ambiente SANDBOX e PRODUÇÃO.
Criada a sua aplicação, a APPDO fornecerá as credenciais necessárias para realização dos testes. Caso persista alguma dúvida com relação às credenciais geradas envolvidos nos processos acesse o item Segurança da documentação desta API.
A utilização do ambiente próprio de testes não é obrigatória, mas recomendamos o procedimento, uma vez que o desenvolvedor necessita compreender se os comportamentos dos sistemas integrados pela API estão adequados à necessidade de utilização dos serviços financeiros e à experiência desejada por sua empresa ou clientes.
A utilização da sua aplicação em produção dependerá do sucesso dos testes executados em algum software de desenvolvimento e teste de APIs disponível no mercado. Sugerimos a instalação da aplicação Postman (https://www.postman.com/downloads/) para auxílio das requisições nos ambientes de testes.
Para realizar requisições nos recursos das APIs, é necessário gerar um Access Token (access_token).
Recomendamos a leitura da documentação sobre Segurança e identifique qual fluxo de Autorização você deve seguir.
Ao criar a sua aplicação, será disponibilizado as suas "Credenciais".
Essas credenciais padrão OAuth, são as quais deverão ser utilizadas para gerar o Access Token.
Abaixo, seguem dicas para geração do Access Token.
1. Você poderá utilizar o Postman para realizar as requisições do OAuth para gerar seu Access token.
2. Para facilitar, utilize a chave já convertida em BASE64 fornecida pela APPDO, pois está no formato que você deverá utilizar nas requisições do OAuth.
3. Fique atento para utilizar os endpoints corretos para o ambiente de testes.
4. Fazendo as requisições no ambiente de SanboxBox.
5. Sugerimos que você utilize o Postman para fazer suas primeiras requisições na API.
6. Faça toda a sequência de acionamento sugerida, entendendo quais são os dados requeridos na requisição e quais são os retornados.
7. A utilização do Postman facilita o entendimento do funcionamento, antes da implementação no seu projeto.