Criar um formulário de interface digital

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 4 min. de leitura

    • Crie uma interface digital para uma integração no Arquitetura empresarial(anteriormente Application Portfolio Management).

    Campos do formulário 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, gerente e proprietário da interface.
    Nota:
    Este atributo pode ficar vazio se não houver aplicação de negócios em seu repositório. Se você estiver usando interfaces abertas, como Tempo ou Serviço financeiro, só conhecerá a interface e a rastreará sem uma aplicação de negócios relacionada.
    Tipo de interface Tipo de API usada pela interface. 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

    APIs públicas ou abertas estão disponíveis para qualquer pessoa e podem ser usadas sem restrições ou acordos de licença.

    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. Essas APIs têm termos e condições especiais de uso.
    Primário Nome da interface primária.

    Muitas vezes, 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 fases do ciclo de vida principal 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:
    • Ideação: Em avaliação, piloto
    • Design: Chartered, Design, Build
    • Implantar: Teste
    • 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 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 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. Ele ajuda os proprietários e arquitetos da aplicação a decidir qual versão da interface desejam usar.
    Tabela 1. Campos da seção Proprietários
    Campo Descrição
    Responsável pelo negócio O proprietário da função de negócios, que é o proprietário da interface digital. Pode ser a mesma pessoa que possui a aplicação de negócios primária.
    Proprietário da TI O responsável na organização DE TI, que é o proprietário da 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 à interface digital.
    Grupo de suporte Nome do grupo que fornece suporte à interface digital.
    Tabela 2. Campos da seção funcional
    Campo Descrição
    Protocolo Tipo de protocolo usado pela interface. 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 é completa 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 é completa e pode ser estendida adicionando seus valores preferenciais ou ocultando os valores fornecidos.
    Tabela 3. Campos 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 usado 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 da seção Atividades
    Campo Descrição
    Anotações de trabalho Comentários sobre a interface.
    Criar ou atualizar uma interface digital