Skip to content
This repository was archived by the owner on May 20, 2022. It is now read-only.

Latest commit

 

History

History
99 lines (60 loc) · 5.21 KB

README.md

File metadata and controls

99 lines (60 loc) · 5.21 KB

Technee

Aspectos técnicos

APIs

Estão disponibilizados alguns endpoints de APIs cujas chamadas e resultados simulam o que seriam algumas funcionalidades caso implementadas em ambiente produtivo.

As APIs seguem a abordagem arquitetural REST. Esta abordagem disponibiliza informações de sistemas através de URLs que respondem textos em JSON e utilizam recursos do protocolo HTTP. Esta abordagem é amplamente conhecida e com abundante material disponibilizado na internet.

Aquelas que tratam de consulta de informações bancárias foram inspiradas e são semelhantes às APIs do Open Banking United Kingdom. Assim, para informações mais completas além das presentes neste guia, consulte as especificações do Open Banking. As outras APIs fora do escopo do Open Banking foram inspiradas nos padrões do Open Banking, mas não haverá documentação no Open Banking United Kingdon sobre elas.

Para acesso às APIs, deve-se fazer um fluxo de Client Credentials do OAUTH2.0. Para mais informações não presentes neste guia, consulte a documentação oficial do OAUTH2.0.

Endpoints

São disponibilizadas funcionalidades através dos seguintes endpoints:

Consulta dados da conta

GET [host]/open-banking/v1/accounts/{accountId}

Consulta saldo da conta

GET [host]/open-banking/v1/accounts/{accountId}/balances

Consulta extrato da conta

GET [host]/open-banking/v1/accounts/{accountId}/transactions

Transfere valores entre contas

GET [host]/accounts/v1/accounts/{accountId}/transfers

Cadastra uma intenção de abertura de conta (Opt In)

POST [host]/accounts/v1/optin

Lista os Morning Calls

GET [host]/media/v1/youtube?{filtros via query strings}

Consulta se a aplicação que fornece as APIs está funcionando

GET [host]/health

Host

O host https://af3tqle6wgdocsdirzlfrq7w5m.apigateway.sa-saopaulo-1.oci.customer-oci.com/fiap-sandbox deve ser adicionado antes do caminho de cada um dos endpoints acima.

Ex:

  • GET https://af3tqle6wgdocsdirzlfrq7w5m.apigateway.sa-saopaulo-1.oci.customer-oci.com/fiap-sandbox/health
  • GET https://af3tqle6wgdocsdirzlfrq7w5m.apigateway.sa-saopaulo-1.oci.customer-oci.com/fiap-sandbox/accounts/v1/optin

Parâmetros dos cenários simulados

Para acesso aos cenários simulados disponíveis com headers, bodies, query parameters etc., importe este Postman Collection no Postman.

Para entendimento do fluxo de negócio envolvido nos cenários simulados e outros detalhes técnicos, consulte este documento em PDF

OAUTH

Para acesso às APIs, um access token deve ser utilizado e enviado em todas as requisições. Para obtenção do access token:

1 - Concatene o client_id e secret (ver valores disponíveis na tabela abaixo) separando-os com : (dois pontos). Ex:

abcedfgh_SEU_CLIENT_ID_abcedfgh:abcedfgh_SEU_SECRET_abcedfgh

2 - Converta em uma string em BASE64:

YWJjZWRmZ2hfU0VVX0NMSUVOVF9JRF9hYmNlZGZnaDphYmNlZGZnaF9TRVVfU0VDUkVUX2FiY2VkZmdo

3 - Submeta a string no header Authorization com o tipo Basic via POST no endpoint https://idcs-902a944ff6854c5fbe94750e48d66be5.identity.oraclecloud.com/oauth2/v1/token:

Authorization: Basic YWJjZWRmZ2hfU0VVX0NMSUVOVF9JRF9hYmNlZGZnaDphYmNlZGZnaF9TRVVfU0VDUkVUX2FiY2VkZmdo

4 - Com o access_token retornado, faça as chamadas nos outros endpoints (transfers, optin, balances etc.) passando-o no header Authorization com o tipo Bearer:

Authorization: Bearer eyJ4NXQj...EuwHBw

O modelo completo desta chamada encontra-se no Postman Collection e no documento em PDF.

Lista de client_id e secret

client_id secret
f9d3cd9600874ac2803d03ca709b78eb 1a2075e3-b15e-4324-902c-0f12f8f08082
e33b611a81204f318a15d5728b998661 31591ad2-1cbd-44e9-a01c-1bbcc0985544
bfcfae0f5b3343e0b357188435682fee 46a29eb0-40d9-432e-a63b-81892110ae78
a8e3bab206d24a89b9b113cc493a2350 18286459-3c66-4bb5-943d-00dcb4fdb76d
b5fb1e3b36714ad0a08e9fd541d00160 a70413b9-8837-47df-885e-3d0449feabf5
9dffe873bf3b44b3ad067e87f354bef4 86a1a12e-595d-474e-8280-d0d26cbb53b7
efb4731160b54078ab7bf69cf1e1a5b7 449818dd-fdf2-4897-b914-ea8b5921a0f2
f892fe88abc443ac9362e11125092313 a71948e5-02fc-48ec-b8bc-4e3b7ebb2cd0
70a973924bdd4defb211bfd1c0309771 51971ed5-9704-4757-924a-d3431a2ae60d
94ed03ad9c8b4b079ff28ec854fab801 06173366-3c28-4b9f-a652-bbaddc532f2b

Suporte técnico

Issues no GitHub

Podem ser abertos Issues no GitHub do Hackathon para dúvidas técnicas das APIs.

Para verificar a disponibilidade do ambiente das APIs:

  • o endpoint de health check (GET [host]/health) deve responder um HTTP Status Code 200 (Ok) utilizando um access token válido.