O presente documento fornece orientações para utilização do Gerenciador de Configuração para inclusão, atualização e exclusão de dados relativos a APIs no ecossistema do Open Finance Brasil.
Inclusão de dados
Novos dados devem ser incluídos seguindo a ordem abaixo:
Dados de Fases
Dados de APIs
Dados de Versões de APIs
Dados de Endpoints
Dados de URIs dos Endpoints
Para isso, o primeiro passo é acessar o Formulário de Fases e preencher os campos de:
Identificador da fase (criar um número sequencial inteiro com base na última fase adicionada à tabela de Fases - verificar tabela na seção de Atualização de dados);
Nome da fase (esse campo poderá ser um texto - CamelCase com espaço para separação das palavras quando necessário - ou um numeral);
Grupo da fase (campo texto - CamelCase com espaço para separação das palavras quando necessário - com a nomenclatura do grupo da fase).
Para cadastrar novas APIs, acesse o formulário de APIs e preencha as infomações para:
Identificador da API (criar um número sequencial inteiro com base na última API adicionada à tabela de APIs - verificar tabela na seção de Atualização de dados);
Nome da API (campo texto - CamelCase com espaço para separação das palavras quando necessário);
Nome curto da API (o nome curto da API pode ser apenas a repetição do nome da API ou um encurtamento caso o nome da API seja muito extenso. É um campo texto em CamelCase com espaço para separação das palavras quando necessário);
Family type da API (esse campo é preenchido em inglês, com todas as letra minúsculas e com hífen para separar as palavras quando necessário);
Identificador da fase da API (verificar a tabela de Fases para identificar essa informação).
Para cadastro de uma nova versão de API, acesse o formulário de APIs Versions e preencha as informações para:
Identificador da Versão da API (criar um número sequencial inteiro com base na última versão de API adicionada à tabela de versões de APIs - verificar tabela na seção de Atualização de dados);
Identificador da API (verificar a tabela de APIs para identificar essa informação);
Nome da API (este campo deverá conter o nome da API e um primeiro complemento quando necessário. É um campo texto em CamelCase com espaço para separação das palavras quando necessário);
Nome curto da API (esse campo é preenchido em inglês, com todas as letra minúsculas e com hífen para separar as informações. O numeral contido neste campo é o ID criado para essa versão de API);
Versão da API (número do versionamento semântico da API, no formato major.minor.patch);
Status da API (escolher na lista o status em que a versão da API se encontra);
Data de início (preencher com a informação da data de início da versão cadastrada);
Data final (preencher com a informação da data final da versão cadastrada).
Para cadastrar um novo endpoint, acesse o formulário de Endpoints e preencha as informações para:
Identificador do endpoint (criar um número sequencial inteiro com base no último endpoint adicionado à tabela de Endpoints - verificar tabela na seção de Atualização de dados);
Nome do endpoint (campo texto - CamelCase com espaço para separação das palavras quando necessário);
Nome curto do endpoint (o nome curto do endpoint pode ser apenas a repetição do nome do endpoint ou um encurtamento caso o nome do endpoint seja muito extenso. É um campo texto em CamelCase com espaço para separação das palavras quando necessário);
Método do endpoint (escolher na lista o método HTTP para o endpoint cadastrado);
URI do endpoint (cadastrar a URI de acesso ao endpoint);
Frequência de acesso (escolher na lista a frequencia de acesso ao endpoint cadastrado);
SLA (ms) (cadastrar o número inteiro - medido em ms - de SLA para esse endpoint);
Timeout (s) (cadastrar o número inteiro - medido em s - de timeout para esse endpoint);
TPM (cadastrar o número inteiro de TPM para esse endpoint);
TPS (cadastrar o número inteiro de TPS para esse endpoint);
Limite operacional (consultas/mês) ((cadastrar o número inteiro - medido em consultas/mês - de limite operacional para esse endpoint);
Identificador da API (verificar a tabela de APIs para identificar essa informação).
Para fazer o cadastro de uma nova URI para um Endpoint, acesse o formulário de URI Endpoints e preencha as informações para:
Identificador da URI (criar um número sequencial inteiro com base na última URI adicionada à tabela de URI Endpoints - verificar tabela na seção de Atualização de dados);
URI (cadastrar a URI de acesso ao endpoint);
Identificador do endpoint (verificar a tabela de Endpoints para identificar essa informação).
Identificador da versão da API (verificar a tabela de APIs Versions para identificar essa informação).
Atualização de dados
Para fazer atualizações de dados, acesse a tabela que contém as informações a serem atualizadas.
O campo de ID não é possível de ser editado.
Para fazer a edição de campos simples, basta selecionar a o campo e editar a informação conforme necessário.
Para a edição de campos de data, selecione o campo e um calendário irá aparecer em pop-up para a seleção da data desejada.
Você também pode acessar as tabelas para consultar dados necessários para preenchimento de alguns campos dos formulários de inclusão de dados.