Formulário de interface digital

As interfaces digitais são fornecidas como parte de uma aplicação de negócios, mas também podem ser independentes. As interfaces fornecem uma maneira de outras aplicações de negócios interagirem com as aplicações.

Campos de formulário de interface digital

Campo	Descrição
Nome	Nome exclusivo e significativo da interface digital.
Número	Número da interface digital. Este campo é gerado automaticamente com o prefixo DINTF e não pode ser editado.
Aplicação de negócios do fornecedor	Nome da aplicação de negócios do provedor que fornece, gerencia e possui a interface. Nota: Este atributo pode estar vazio se não houver aplicação de negócios no repositório. Se você estiver usando interfaces abertas, como Tempo ou Serviço financeiro, só estará ciente da interface e a rastreará sem uma aplicação de negócios relacionada.
Empresa fornecedora	Nome da empresa fornecedora.
Tipo de interface	Tipo de API usada pela interface. Este campo ajuda a rastrear se a API é pública ou aberta. Nota: Para APIs públicas ou abertas, não haverá nenhuma aplicação de negócios do provedor, a menos que a organização a exponha como uma interface aberta. Use as seguintes opções: API aberta API do parceiro API interna As APIs públicas ou abertas estão disponíveis para qualquer pessoa e podem ser usadas sem restrições ou acordos de licença. As APIs internas ou privadas estão disponíveis somente para usuários autorizados (técnicos) e podem ser usadas sem restrições e regulamentações de uso. As APIs de parceiro estão disponíveis para parceiros autorizados de um provedor de API. Normalmente, essas APIs têm termos e condições especiais de uso.
Primário(a)	Nome da interface primária. Frequentemente, as interfaces são agrupadas ou fazem parte de uma composição. Como você pode fazer referência a uma interface digital na integração digital, use a interface primária. As interfaces digitais relacionadas à interface primária são listadas na lista relacionada da interface.
Versão	Versão da interface. Este campo ajuda a rastrear quais integrações digitais estão usando qual versão de uma interface.
Fase do ciclo de vida	Fase do ciclo de vida da interface. Use as seguintes opções: Ideação Design Implantar Operacional Fim da Vida Útil
Status da fase do ciclo de vida	Status da fase do ciclo de vida da interface. Cada uma das principais fases do ciclo de vida pode ter um ou mais status de fase do ciclo de vida. Por exemplo, uma interface digital na fase operacional pode mudar o status ao longo do tempo de Em uso para Em manutenção para Descontinuação pendente. Use as seguintes opções: Idealização: em avaliação, piloto Design: Fretado, Design, Criar Implantar: testar Operacional: Em uso, Em manutenção, Descontinuação pendente Fim da vida útil: descontinuado, obsoleto
ID do modelo	ID do modelo da interface. Este campo ajuda a rastrear o modelo de interface. Esta é uma referência à tabela de modelo de aplicação na qual você pode gerenciar suas próprias variantes de modelos ou tipos de API. Por exemplo, API de tabela, API de anexo, API agregada e APIs de processo. Este campo opcional pode ser usado para rastrear o modelo de interface. Dependendo do seu caso de uso, você pode adicionar novos modelos e categorias de modelo.
Descrição	Descrição da interface digital. Forneça os aspectos de design de alto nível da interface. Você pode fornecer detalhes como como a interface digital agrega valor, como ela deve ser projetada e como ela deve ser usada. Você também pode descrever diferentes mudanças e capacidades de acordo com a versão da interface. Isso ajuda os responsáveis pela aplicação e os arquitetos a decidir qual versão da interface desejam usar.

Tabela 1. Campos de formulário da seção Proprietários

Campo	Descrição
Responsável pelo negócio	O proprietário da função de negócios, que possui a interface digital. Pode ser a mesma pessoa que possui a aplicação de negócios primária.
Responsável da TI	O proprietário na organização de TI, que possui a interface digital. Pode ser a mesma pessoa que possui a aplicação de negócios primária.
Suporte de	Nome do especialista no assunto (SME) ou indivíduo que fornece suporte para a interface digital.
Grupo de suporte	Nome do grupo que fornece suporte para a interface digital.

Tabela 2. Campos de formulário da seção funcional

Campo	Descrição
Protocolo	Tipo de protocolo usado pela interface. Os Protocolos de API são as especificações que regulam a aplicação. Esses protocolos são usados para integrar interfaces de programação de aplicações com seu software. As opções incluem REST, SOAP, LDAP e assim por diante. Nota: Esta lista não é exaustiva e pode ser estendida adicionando seus valores preferenciais ou ocultando os valores fornecidos.
Formato de mensagem	Formato da mensagem na interface. As opções incluem JSON, XML, CSV e assim por diante. Nota: Esta lista não é exaustiva e pode ser estendida adicionando seus valores preferenciais ou ocultando os valores fornecidos.

Tabela 3. Campos de formulário da seção de autenticação

Campo	Descrição
Tipo de autenticação	Tipo de autenticação usada para autenticar a interface. Use as seguintes opções: Autoriz. básica OpenID Connect Certificado WS-Security LDAP Nenhum(a) Outro Você pode usar os tipos de autenticação fornecidos pelo sistema ou adicionar o seu.
Tipo de autorização	Tipo de autorização usada para autorizar a interface. Use as seguintes opções: Token OAuth 2.0 Token JWT Web Token SAML 2.0 Outro Sem autorização Você pode usar os tipos de autenticação fornecidos pelo sistema ou adicionar o seu.

Tabela 4. Campos de formulário da seção de atividades

Campo	Descrição
Anotações de trabalho	Comentários sobre a interface.

Tarefas relacionadas

• Adicionar ou editar uma interface digital no Espaço do EA