Março
25/03/2025
Registro de APIs no Gateway
Com o objetivo de assegurar a conformidade com os padrões estabelecidos para o registro de APIs no Gateway do Studio Aplicações, informamos que, a partir desta data, todas as solicitações de registro de APIs serão centralizadas e atendidas pela equipe de Integrações, sob a coordenação de Patrick da Silva Cardoso.
A equipe de Integrações será responsável por realizar uma curadoria detalhada dos registros, abrangendo:
- Nomenclatura das APIs
- Recursos e escopos
- Padrões de representação
- Códigos de resposta
- Entre outros aspectos técnicos e de boas práticas.
Essa medida visa garantir a aplicação consistente dos padrões que estão sendo revisados pela própria equipe de Integrações, promovendo uniformidade e qualidade na gestão de APIs.
Orientações para solicitação
As solicitações devem ser registradas no Jira de Desenvolvimento, utilizando o seguinte modelo para os chamados:
Projeto: INT (Integrações)
Tipo de Item: Requisição
Resumo: Registro de APIs no Gateway
Exemplo de descrição:
Bom dia,
Cadastrar os endpoints abaixo no gateway, conforme a planilha
Mapeamento APIs - Desenvolvimento.Aba: API Educação
Linhas: 48..49Endpoints:
{code:java}
https://api.merenda.betha.cloud/merenda/dados/api/cardapio
https://api.merenda.betha.cloud/merenda/dados/api/cardapio-grupo-consumo
{code}
Para mais informações sobre como criar a requisição de registro, consulte o exemplo disponível em:
INT-494
Contamos com a colaboração de todos para o sucesso desta iniciativa.
Atenciosamente,
Equipe de Integrações