/
09. Cadastrando recursos de uma API

ESTE É UM CONTEÚDO EM DESENVOLVIMENTO E NÃO DEVE SER CONSIDERADO COMO VERSÃO FINAL!
Clique aqui para maiores informações

09. Cadastrando recursos de uma API

Esta seção explica as etapas para cadastrar os endpoints de recursos de uma API.


Cadastramento de Recursos - Fase 1

Para cada uma das famílias de APIs devem ser adicionadas todos os endpoints disponíveis. Supondo que a instituição tenha disponibilizado dados em todos os endpoints da fase 1, a publicação deveria ser:


Cadastramento de Recursos - Fase 2

Na Fase 2 o padrão de cadastramento continua como na Fase 1, segue alguns pontos de atenção:

 

  • Para a API de consentimento é necessário apenas o cadastramento de uma entrada para o GET e o DELETE;

  • A API de customers foi dividida em duas famílias para facilitar o consumo pelos receptores. Customers-business onde é cadastrado os Endpoints PJ e customers-personal onde será cadastrado os endpoints PF. Cabendo aqui o cadastramento conforme a disponibilização do produto pela instituição;

  • O cadastramento de recursos deve respeitar a tabela de etapas da implementação assistida, conforme IN BCB n° 136 de 29/7/2021;

  • Para as APIs v2 da Fase 2 será necessário adicionar novos Family tipes informando a versão 2 e sua certificação.

Exemplo de preenchimento, levando em consideração que a instituição disponibilize tanto PF e PJ e o inicio da implementação assistida.

Cadastramento de Recursos - Fase 3

Na Fase 3 o padrão de segue alguns pontos de atenção:

 

  • A API de payments foi dividida para facilitar o consumo pelos iniciadores.

  • Na família de payments-consents devem ser declarados os endpoints de consentimento.

  • Na família de payments-pix devem ser declarado sos endpoints da forma de pagamento PIX.

  • Demais formas de pagamentos devem ser cadastradas conforme as especificações avancem.


Tabela Exemplo de Recursos - Fase 1

API

Diretório (Family Type)

Recursos (resources)

discovery

discovery

https://api.banco.com.br/open-banking/discovery/v1/status

https://api.banco.com.br/open-banking/discovery/v1/outages

channels

channels

https://api.banco.com.br/open-banking/channels/v1/branches

https://api.banco.com.br/open-banking/channels/v1/electronic-channels

https://api.banco.com.br/open-banking/channels/v1/phone-channels

https://api.banco.com.br/open-banking/channels/v1/banking-agents

https://api.banco.com.br/open-banking/channels/v1/shared-automated-teller-machines

products-services

products-services

https://api.banco.com.br/open-banking/products-services/v1/personal-accounts

https://api.banco.com.br/open-banking/products-services/v1/business-accounts

https://api.banco.com.br/open-banking/products-services/v1/personal-loans

https://api.banco.com.br/open-banking/products-services/v1/business-loans

https://api.banco.com.br/open-banking/products-services/v1/personal-financings

https://api.banco.com.br/open-banking/products-services/v1/business-financings

https://api.banco.com.br/open-banking/products-services/v1/personal-invoice-financings

https://api.banco.com.br/open-banking/products-services/v1/business-invoice-financings

https://api.banco.com.br/open-banking/products-services/v1/personal-credit-cards

https://api.banco.com.br/open-banking/products-services/v1/business-credit-cards

https://api.banco.com.br/open-banking/products-services/v1/personal-unarranged-account-overdraft

https://api.banco.com.br/open-banking/products-services/v1/business-unarranged-account-overdraft

admin

admin

https://api.banco.com.br/open-banking/admin/v1/metrics


Tabela Exemplo de Recursos - Fase 2

API

Diretório (Family Type)

Recursos (resources)

consents

consents

https://api.banco.com.br/open-banking/consents/v1/consents

https://api.banco.com.br/open-banking/consents/v1/consents/{consentId}

resources

resources

https://api.banco.com.br/open-banking/resources/v1/resources

customers

customers-bussines

customers-personal

customers-personal

https://api.banco.com.br/open-banking/customers/v1/personal/identifications

https://api.banco.com.br/open-banking/customers/v1/personal/qualifications

https://api.banco.com.br/open-banking/customers/v1/personal/financial-relations

 

customers-bussines

https://api.banco.com.br/open-banking/customers/v1/business/identifications

https://api.banco.com.br/open-banking/customers/v1/business/qualifications

https://api.banco.com.br/open-banking/customers/v1/business/financial-relations

credit-cards-accounts

credit-cards-accounts

https://api.banco.com.br/open-banking/credit-cards-accounts/v1/accounts

https://api.banco.com.br/open-banking/credit-cards-accounts/v1/accounts/{creditCardAccountId}

https://api.banco.com.br/open-banking/credit-cards-accounts/v1/accounts/{creditCardAccountId}/limits

https://api.banco.com.br/open-banking/credit-cards-accounts/v1/accounts/{creditCardAccountId}/transactions

https://api.banco.com.br/open-banking/credit-cards-accounts/v1/accounts/{creditCardAccountId}/bills

https://api.banco.com.br/open-banking/credit-cards-accounts/v1/accounts/{creditCardAccountId}/bills/{billId}/transactions

accounts

accounts

https://api.banco.com.br/open-banking/accounts/v1/accounts

https://api.banco.com.br/open-banking/accounts/v1/accounts/{accountId}

https://api.banco.com.br/open-banking/accounts/v1/accounts/{accountId}/balances

https://api.banco.com.br/open-banking/accounts/v1/accounts/{accountId}/transactions

https://api.banco.com.br/open-banking/accounts/v1/accounts/{accountId}/overdraft-limits

loans

loans

https://api.banco.com.br/open-banking/loans/v1/contracts

https://api.banco.com.br/open-banking/loans/v1/contracts/{contractId}

https://api.banco.com.br/open-banking/loans/v1/contracts/{contractId}/warranties

https://api.banco.com.br/open-banking/loans/v1/contracts/{contractId}/payments

https://api.banco.com.br/open-banking/loans/v1/contracts/{contractId}/scheduled-instalments

financings

financings

https://api.banco.com.br/open-banking/financings/v1/contracts

https://api.banco.com.br/open-banking/financings/v1/contracts/{contractId}

https://api.banco.com.br/open-banking/financings/v1/contracts/{contractId}/warranties

https://api.banco.com.br/open-banking/financings/v1/contracts/{contractId}/payments

https://api.banco.com.br/open-banking/financings/v1/contracts/{contractId}/scheduled-instalment

unarranged-accounts-overdraft

unarranged-accounts-overdraft

https://api.banco.com.br/open-banking/unarranged-accounts-overdraft/v1/contracts

https://api.banco.com.br/open-banking/unarranged-accounts-overdraft/v1/contracts/{contractId}

https://api.banco.com.br/open-banking/unarranged-accounts-overdraft/v1/contracts/{contractId}/warranties

https://api.banco.com.br/open-banking/unarranged-accounts-overdraft/v1/contracts/{contractId}/payments

https://api.banco.com.br/open-banking/unarranged-accounts-overdraft/v1/contracts/{contractId}/scheduled-instalments

invoice-financings

invoice-financings

https://api.banco.com.br/open-banking/invoice-financings/v1/contracts

https://api.banco.com.br/open-banking/invoice-financings/v1/contracts/{contractId}

https://api.banco.com.br/open-banking/invoice-financings/v1/contracts/{contractId}/warranties

https://api.banco.com.br/open-banking/invoice-financings/v1/contracts/{contractId}/payments

https://api.banco.com.br/open-banking/invoice-financings/v1/contracts/{contractId}/scheduled-instalments


Tabela Exemplo de Recursos - Fase 2 v2

API

Diretório (Family Type)

Recursos (resources)

consents

consents

https://api.banco.com.br/open-banking/consents/v2/consents

https://api.banco.com.br/open-banking/consents/v2/consents/{consentId}

resources

resources

https://api.banco.com.br/open-banking/resources/v2/resources

customers

customers-bussines

customers-personal

customers-personal

https://api.banco.com.br/open-banking/customers/v2/personal/identifications

https://api.banco.com.br/open-banking/customers/v2/personal/qualifications

https://api.banco.com.br/open-banking/customers/v2/personal/financial-relations

 

customers-bussines

https://api.banco.com.br/open-banking/customers/v2/business/identifications

https://api.banco.com.br/open-banking/customers/v2/business/qualifications

https://api.banco.com.br/open-banking/customers/v2/business/financial-relations

credit-cards-accounts

credit-cards-accounts

https://api.banco.com.br/open-banking/credit-cards-accounts/v2/accounts

https://api.banco.com.br/open-banking/credit-cards-accounts/v2/accounts/{creditCardAccountId}

https://api.banco.com.br/open-banking/credit-cards-accounts/v2/accounts/{creditCardAccountId}/limits

https://api.banco.com.br/open-banking/credit-cards-accounts/v2/accounts/{creditCardAccountId}/transactions

https://api.banco.com.br/open-banking/credit-cards-accounts/v2/accounts/{creditCardAccountId}/transactions-current

https://api.banco.com.br/open-banking/credit-cards-accounts/v2/accounts/{creditCardAccountId}/bills

https://api.banco.com.br/open-banking/credit-cards-accounts/v2/accounts/{creditCardAccountId}/bills/{billId}/transactions

accounts

accounts

https://api.banco.com.br/open-banking/accounts/v2/accounts

https://api.banco.com.br/open-banking/accounts/v2/accounts/{accountId}

https://api.banco.com.br/open-banking/accounts/v2/accounts/{accountId}/balances

https://api.banco.com.br/open-banking/accounts/v2/accounts/{accountId}/transactions

https://api.banco.com.br/open-banking/accounts/v2/accounts/{accountId}/transactions-current

https://api.banco.com.br/open-banking/accounts/v2/accounts/{accountId}/overdraft-limits

loans

loans

https://api.banco.com.br/open-banking/loans/v2/contracts

https://api.banco.com.br/open-banking/loans/v2/contracts/{contractId}

https://api.banco.com.br/open-banking/loans/v2/contracts/{contractId}/warranties

https://api.banco.com.br/open-banking/loans/v2/contracts/{contractId}/payments

https://api.banco.com.br/open-banking/loans/v2/contracts/{contractId}/scheduled-instalments

financings

financings

https://api.banco.com.br/open-banking/financings/v2/contracts

https://api.banco.com.br/open-banking/financings/v2/contracts/{contractId}

https://api.banco.com.br/open-banking/financings/v2/contracts/{contractId}/warranties

https://api.banco.com.br/open-banking/financings/v2/contracts/{contractId}/payments

https://api.banco.com.br/open-banking/financings/v2/contracts/{contractId}/scheduled-instalment

unarranged-accounts-overdraft

unarranged-accounts-overdraft

https://api.banco.com.br/open-banking/unarranged-accounts-overdraft/v2/contracts

https://api.banco.com.br/open-banking/unarranged-accounts-overdraft/v2/contracts/{contractId}

https://api.banco.com.br/open-banking/unarranged-accounts-overdraft/v2/contracts/{contractId}/warranties

https://api.banco.com.br/open-banking/unarranged-accounts-overdraft/v2/contracts/{contractId}/payments

https://api.banco.com.br/open-banking/unarranged-accounts-overdraft/v2/contracts/{contractId}/scheduled-instalments

invoice-financings

invoice-financings

https://api.banco.com.br/open-banking/invoice-financings/v2/contracts

https://api.banco.com.br/open-banking/invoice-financings/v2/contracts/{contractId}

https://api.banco.com.br/open-banking/invoice-financings/v2/contracts/{contractId}/warranties

https://api.banco.com.br/open-banking/invoice-financings/v2/contracts/{contractId}/payments

https://api.banco.com.br/open-banking/invoice-financings/v2/contracts/{contractId}/scheduled-instalments


Tabela Exemplo de Recursos - Fase 3


Etapa 1: Cadastrando um Novo Recurso de uma API

Requisitos

1. No Diretório, localize e selecione a sua organização.

 

2. Selecione o menu Authorisation Servers e clique no link do servidor de autorização na qual se deseja cadastrar os recursos.

 

3. No canto superior esquerdo da página clique em API Resources.

 

4. Na página que será carregada clique no botão New API Resources para abrir a janela New API Resource.

 

5. Na janela New API Resource, clique na caixa de seleção API Family Type e selecione uma das opções disponíveis.

 

6. No campo ao lado, em Version especifique o valor apropriado utilizando versionamento semântico (major.minor.patch, exemplo 1.0.7)

 

 

 

 


7. No campo Certification URL é necessário informar a URL onde se encontra a localização do certificado publicado no GitHub. Esse preenchimento é obrigatório para famílias de API’s a partir da Fase 2 e clique no botão Save.

 

NOTA 1: A URL a ser informada deve ser a presente no GitHub no caminho: conformance > submissions/functional selecionando a API especifica e informar a URL com o artefato de certificação .zip.

Exemplo: https://openbanking-brasil.github.io/conformance/submissions/functional/<family-type>/<version>/<file-name>.zip

NOTA 2: No ambiente de Sandbox do Diretório, caso não exista uma certificação, é possível incluir um endereço para testes: https://openbanking-brasil.github.io/teste.zip

8. De volta a tela API Resources, informe URL principal no campo API Discovery Endpoints,