[GDC][API] Inclusão de dados
- Belisa Andrade do Amaral (Unlicensed)
- Bruno Telles Farsura
- Cicero Vieira
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).
Home
Os dados apresentados na página Home são as APIs e o status de cada versão onde o status pode ser selecionado a partir dos botões marcados em azul.
Esta é uma página de visualização apenas e não há inclusão ou edição de dados a partir desta.
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 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 |
URL da documentação | Link da documentação no confluence para a documentação da fase. | Campo texto em CamelCase com espaço para separação das palavras quando necessário | https://openfinancebrasil.atlassina.net/pagina_fase |
Nome abreviado | Nome abreviado da fase | Campo texto em letras maiúsculas sem espaço com dois caracteres | DA |
Para o cadastro de uma nova fase, clique no botão Criar nova Fase e um painel lateral abrirá com os campos para preenchimento. Para finalizar o cadastro após o preenchimento clique no botão Salvar.
Para edição ou exclusão clique na linha desejada e o painel lateral abrirá. Altere o campo necessário e clique em Salvar. Caso deseje excluir a linha cadastrada inteira, clique no botão Excluir.
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 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 |
Fase | No campo de escolha | Campo numérico | 2 |
URL documentação | Link da documentação no confluence para a documentação da fase. | Campo texto em CamelCase com espaço para separação das palavras quando necessário | https://openfinancebrasil.atlassina.net/pagina_api |
Para o cadastro de uma nova API, clique no botão Criar nova API e um painel lateral abrirá com os campos para preenchimento. Para finalizar o cadastro após o preenchimento clique no botão Salvar.
Para edição ou exclusão clique na linha desejada e o painel lateral abrirá. Altere o campo necessário e clique em Salvar. Caso deseje excluir a linha cadastrada inteira, clique no botão Excluir.
Versão das 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 |
|---|---|---|---|
Identificador da API (API) | Selecionar na lista a API no qual a versão pertence | Campo relacionado à tabela-pai | Admin |
Versão da API (versão) | Número do versionamento semântico da API, no formato major.minor.patch | Campo texto | 2.1.0 |
Nome da versão da API | Nomenclatura da family type da API, em inglês com o identificador da versão da API. | Campo texto com todas as letras minúsculas e com hífen para separar as informações | resources-13 |
URL documentação | Link da documentação no confluence para a documentação da fase. | Campo texto em CamelCase com espaço para separação das palavras quando necessário | https://openfinancebrasil.atlassina.net/pagina_versao_api |
Para o cadastro de uma nova versão de API, clique no botão Criar nova versão de API e um painel lateral abrirá com os campos para preenchimento. Para finalizar o cadastro após o preenchimento clique no botão Salvar.
Para edição ou exclusão clique na linha desejada e o painel lateral abrirá. Altere o campo necessário e clique em Salvar. Caso deseje excluir a linha cadastrada inteira, clique no botão Excluir.
Status da versão 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 |
|---|---|---|---|
Identificador da Versão da API (Identificador versão) | Identificador da versão da API formatado da seguinte forma: | Campo relacionado à tabela-pai | Comuns::1.0.2::discovery-25 |
Versão da API (Versão) | 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:
| Current |
Data de início (Data início) | Preencher campo com a informação da data de início da versão cadastrada | Campo de data | 2024-11-25 |
Data final (Data final) | Preencher campo com a informação da data final da versão cadastrada | Campo de data | 2024-11-25 |
Há uma automação no banco de dados, onde ao criar uma nova versão de API, indicado na página anterior, são criados os status Current, Implementing, Certifying, Deprecated, Retired. Para finalizar o preenchimento dos dados do status da versão da API clique na linha desejada e altere os campos Data início e Data final. Ao finalizar o preenchimento dos dados clique no botão Salvar.
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 |
|---|---|---|---|
Título (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 (api) | Selecionar na lista a API no qual o endpoint pertence | Campo relacionado à tabela-pai | 118 |
Para o cadastro de um novo endpoint, clique no botão Criar novo Endpoint e um painel lateral abrirá com os campos para preenchimento. Para finalizar o cadastro após o preenchimento clique no botão Salvar.
Para edição ou exclusão clique na linha desejada e o painel lateral abrirá. Altere o campo necessário e clique em Salvar. Caso deseje excluir a linha cadastrada inteira, clique no botão Excluir.
URI 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 |
|---|---|---|---|
URI (uri) | Cadastrar a URI de acesso ao endpoint | Campo texto | /admin/v2/metrics |
Identificador do endpoint (endpoint) | Selecionar na lista o Endpoint no qual o URI pertence | Campo relacionado à tabela-pai | 1 |
Identificador da versão da API (apis_version) | Selecionar na lista a versão da API no qual o URI pertence | Campo relacionado à tabela-pai | 2.0.0 |
Para o cadastro de um novo URI endpoint, clique no botão Criar novo URI para endpoint e um painel lateral abrirá com os campos para preenchimento. Para finalizar o cadastro após o preenchimento clique no botão Salvar.
Para edição ou exclusão clique na linha desejada e o painel lateral abrirá. Altere o campo necessário e clique em Salvar. Caso deseje excluir a linha cadastrada inteira, clique no botão Excluir.