Visão geral da interface do Gerenciador de Configuração

Novos dados devem ser incluídos seguindo a ordem abaixo, sempre que uma nova fase, API, versão de API, Endpoint ou URI for lançada (seguindo os informes do GT de Comunicação).

1 Dados de Fases
2 Dados de APIs
3 Dados de Versões de APIs
4 Dados do status das versões das APIs
5 Dados de Endpoints
6 Dados de URIs de Endpoints

Dados de Fases

Para isso, o primeiro passo é acessar o Formulário de Fases e preencher os campos de:

Nome do campo	Descrição	Tipo de campo	Exemplo de preenchimento

Nome do campo

Descrição

Tipo de campo

Exemplo de preenchimento

Nome da fase

(nome)

Nomenclatura da fase

Campo texto em CamelCase com espaço para separação das palavras quando necessário (poderá conter tanto texto quanto numeral)

4A

Grupo da fase

(grupo)

Nomenclatura do grupo da fase

Campo texto em CamelCase com espaço para separação das palavras quando necessário

Dados Abertos

Formulário de inclusão de dados de Fases

Dados de APIs

Para cadastrar novas APIs, acesse o formulário de APIs e preencha as infomações para:

Nome do campo	Descrição	Tipo de campo	Exemplo de preenchimento

Nome do campo	Descrição	Tipo de campo	Exemplo de preenchimento
Nome da API (nome)	Nomenclatura da API	Campo texto em CamelCase com espaço para separação das palavras quando necessário	Cartão de Crédito
Nome curto da API (api_short_name)	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	Campo texto em CamelCase com espaço para separação das palavras quando necessário	Cartão de Crédito
Family type da API (family_type)	Nomenclatura da family type da API, em inglês	Campo texto com todas as letras minúsculas e com hífen para separar as palavras quando necessário	credit-cards-accounts
Identificador da fase da API (fases_id)	Verificar a tabela de Fases para identificar essa informação. Clique no botão “Fields” e em seguida no botão “Show system fields” e então consulte a coluna “id”.	Campo numérico	2

Dados de Versões de APIs

Para cadastro de uma nova versão de API, acesse o formulário de APIs Versions e preencha as informações para:

Nome do campo	Descrição	Tipo de campo	Exemplo de preenchimento

Nome do campo	Descrição	Tipo de campo	Exemplo de preenchimento
Identificador da API (apis)	Verificar a tabela de APIs para identificar essa informação. Clique no botão “Fields” e em seguida no botão “Show system fields” e então consulte a coluna “id”.	Campo relacionado à tabela-pai	118
Nome da API (api_hidden)	Este campo deverá conter o nome da API e um primeiro complemento quando necessário	Campo texto em CamelCase com espaço para separação das palavras quando necessário	Recursos
Nome curto da API (name)	Nomenclatura da family type da API, em inglês com o identificador da versão da API. Para verificar a informação do identificador da versão, clique no botão “Fields” na tabela de “apis_versions” e em seguida no botão “Show system fields” e então consulte a coluna “id”.	Campo texto com todas as letras minúsculas e com hífen para separar as informações	resources-13
Versão da API (version)	Número do versionamento semântico da API, no formato major.minor.patch	Campo texto	2.1.0
Status da API (status)	Escolher na lista o status em que a versão da API se encontra. Apenas uma versão da API pode ser classificada com o status “Current”.	Campo com valores pré-determinados	Current
Data de início (start_date)	Preencher campo com a informação da data de início da versão cadastrada	Campo de data	2024-11-25
Data final (end_date)	Preencher campo com a informação da data final da versão cadastrada	Campo de data	2024-11-25

Colunas com o ícone com os dados descritos dentro de balões na cor cinza são colunas de look up que mostram informações descritas para complementar informções de ID.

Não se preocupe em preencher essas colunas, é necessário incluir informações apenas nas colunas descritas nas tabelas presentes nesse manual.

Dados do status das versões das APIs

O cadastro do status de uma nova versão de uma API é feita de forma automática, portanto não há a necessidade de intervenção humana no cadastro.

Nome do campo	Descrição	Tipo de campo	Exemplo de preenchimento

Nome do campo	Descrição	Tipo de campo	Exemplo de preenchimento
Identificador da Versão da API (apis_versions_id)	Verificar a tabela de Versões de APIs para identificar essa informação. Clique no botão “Fields” e em seguida no botão “Show system fields” e então consulte a coluna “id”.	Campo relacionado à tabela-pai	118
Versão da API (apis_versions)	Este campo deverá conter o nome da versão da API e um primeiro complemento quando necessário	Campo relacionado à tabela-pai	Recursos
Status da API (status)	Escolher na lista o status em que a versão da API se encontra.	Campo com valores pré-determinados. O valores possíveis são: Certifying Implementing Current Deprecated Retired	Current
Data de início (start_date)	Preencher campo com a informação da data de início da versão cadastrada	Campo de data	2024-11-25
Data final (end_date)	Preencher campo com a informação da data final da versão cadastrada	Campo de data	2024-11-25

Quando uma versão de uma API é criada na tabela apis_versions todos os possíveis status dessa versão já são criados na tabela apis_versions_status automaticamente, não sendo necessária a intervenção humana para o cadastro de novos status para a versão da API.

Colunas com o ícone com os dados descritos dentro de balões na cor cinza são colunas de look up que mostram informações descritas para complementar informções de ID.

Não se preocupe em preencher essas colunas, é necessário incluir informações apenas nas colunas descritas nas tabelas presentes nesse manual.

Dados de Endpoints

Para cadastrar um novo endpoint, acesse o formulário de Endpoints e preencha as informações para:

Nome do campo	Descrição	Tipo de campo	Exemplo de preenchimento

Nome do campo	Descrição	Tipo de campo	Exemplo de preenchimento
Nome do endpoint (title)	Nomenclatura do endpoint	Campo texto em CamelCase com espaço para separação das palavras quando necessário	Adiantamento a Depositantes - Contrato
Nome curto do endpoint (short_name)	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	Campo texto em CamelCase com espaço para separação das palavras quando necessário	Contrato
Método do endpoint (method)	Escolher na lista o método HTTP para o endpoint cadastrado	Campo com valores pré-determinados	GET
URI do endpoint (uri)	Cadastrar a URI de acesso ao endpoint	Campo texto	/contracts/{contractId}
Frequência de acesso (frequency)	Escolher na lista a frequencia de acesso ao endpoint cadastrado	Campo com valores pré-determinados	Baixa
SLA (ms) (sla_ms)	Cadastrar o número inteiro - medido em ms - de SLA para esse endpoint	Campo numérico	4000
Timeout (s) (timeout_s)	Cadastrar o número inteiro - medido em s - de timeout para esse endpoint	Campo numérico	15
TPM (tpm)	Cadastrar o número inteiro de TPM para esse endpoint	Campo numérico	500
TPS (tps)	Cadastrar o número inteiro de TPS para esse endpoint	Campo numérico	300
Limite operacional (consultas/mês) (limit_op_mes)	Cadastrar o número inteiro - medido em consultas/mês - de limite operacional para esse endpoint	Campo numérico	4
Identificador da API (apis)	Verificar a tabela de APIs para identificar essa informação. Clique no botão “Fields” e em seguida no botão “Show system fields” e então consulte a coluna “id”.	Campo relacionado à tabela-pai	118

Dados de URIs de Endpoints

Para fazer o cadastro de uma nova URI para um Endpoint, acesse o formulário de URI Endpoints e preencha as informações para:

Nome do campo	Descrição	Tipo de campo	Exemplo de preenchimento

Nome do campo

Descrição

Tipo de campo

Exemplo de preenchimento

URI

(uri)

Cadastrar a URI de acesso ao endpoint

Campo texto

/admin/v2/metrics

Identificador do endpoint

(endpoints)

Verificar a tabela de Endpoints para identificar essa informação.

Clique no botão “Fields” e em seguida no botão “Show system fields” e então consulte a coluna “id”.

Campo relacionado à tabela-pai

1

Identificador da versão da API

(apis_versions)

Verificar a tabela de APIs_versions para identificar essa informação.