Criamos uma collection no Postman para que fique claro os endpoints e os possíveis erros que retornam na nossa API.
Passo 1: Escolher a collection
Clique no botão "Run in Postman" da collection que deseja importar:
| Produto | Collection |
|---|---|
| Pagamentos |  |
| Recebimentos | |
| Conta Certa | |
Passo 2: Importar a collection
- Selecionar a forma de utilizar o Postman via web ou via aplicativo. Ambos os formatos funcionam normalmente.
- Acessar sua conta no Postman ou cadastrar uma nova caso ainda não tenha.
- Selecionar um workspace para salvar a collection da Transfeera.
- Feito isso a coleção estará salva na sua conta do Postman:
Passo 3: Configurar ambiente
Cada collection já possui um respectivo environment para ser configurado. Para configurar acesse o menu "Environments" do Postman e configure as variáveis da collection que for utilizar na coluna "Current Value":
Pagamentos e Recebimentos Environment
- LOGIN_API_HOST:
- Sandbox: https://login-api-sandbox.transfeera.com
- Produção: https://login-api.mtls.transfeera.com
- TRANSFEERA_API_HOST:
- Sandbox: https://api-sandbox.transfeera.com
- Produção: https://api.mtls.transfeera.com
- TRANSFEERA_API_CLIENT_ID: Credencial gerada pela plataforma na página "Área do desenvolvedor".
- TRANSFEERA_API_CLIENT_SECRET: Credencial gerada pela plataforma na página "Área do desenvolvedor".
- Veja o passo a passo para gerar as credenciais aqui.
ContaCerta Environment
- LOGIN_API_HOST:
- Sandbox: https://login-api-sandbox.transfeera.com
- Produção: https://login-api.mtls.transfeera.com
- CONTACERTA_API_HOST:
- CONTACERTA_API_CLIENT_ID: Credencial gerada pela plataforma na página "Área do desenvolvedor".
- CONTACERTA_API_CLIENT_SECRET: Credencial gerada pela plataforma na página "Área do desenvolvedor".
- Veja o passo a passo para gerar as credenciais aqui.
Após preencher as variáveis de ambiente clique em "Save" para persistir as alterações do environment. A imagem a seguir exemplifica a configuração do environment de pagamentos:
Passo 4: Autenticação
Em todas as requisições da API Transfeera é necessário enviar o token de acesso. Para gerar este token siga as seguintes etapas:
- No canto superior direito selecione o environment conforme a collection que será utilizada:
- Selecione a collection que deseja gerar o access token.
- Clique em "Get New Access Token".
- Em seguida aparecerá uma tela confirmando se a geração ocorreu com sucesso. Aguarde 5 segundos para ir para a próxima tela ou clique no botão para avançar. Na tela seguinte clique em "Use Token":
Veja mais sobre o processo de autenticação clicando aqui.
Passo 5: Testando requisições
Após ter realizado as configurações e gerado o token de acesso descrito nos passos anteriores, será possível testar as requisições da respectiva collection.
No canto direito do Postman, em documentation, existem informações dos exemplos das requisições descritas na collection.