Publicação Dev Portal
Visão Geral
Após a criação da documentação de uma integração, o próximo passo é disponibilizá-la em um Dev Portal para consumo. O processo de disponibilização de documentação no Dev Portal é chamado de publicação. Uma vez publicada, a documentação estará acessível no menu > Catálogo de Serviços do portal. Para saber mais sobre a visualização do catálogo no portal, acesse a seção Catálogo de Serviços do Dev Portal.
O Dev Portal atua como catálogo centralizador de documentações de toda a organização. Nele, essa documentação pode ser acessada tanto pelos consumidores do serviço de integração quanto pelos próprios desenvolvedores da integração, para fins de registro de regras de negócio e decisões de design do fluxo.
Devido à natureza multi-portal do DHuO, é possível publicar uma documentação em vários portais, bem como ter versões diferentes de uma documentação em cada portal.
A visão do catálogo de todas as documentações de integrações publicadas em um portal está disponível no estúdio do portal, pela administração de portais. Para saber mais sobre o catálogo do Dev Portal, acesse a seção Catálogo da Administração do Dev Portal.
Configuração
A publicação de documentações é gerenciada pela interface do estúdio da integração. A partir da home, acesse o menu > Integrações. Na página de integrações, visualize a integração desejada e acesse o menu > Publicação. Na página de publicações, as documentações podem ser adicionadas, atualizadas ou removidas dos portais.
O processo de publicação envolve a escolha de um portal e uma versão da documentação. Escolha o portal em que a documentação será publicada, selecione a versão da documentação, compare, revise as alterações e realize a publicação.
Para publicar, é necessário ter versionado a documentação. Para saber mais sobre a criação e versionamento de documentações, acesse a seção Documentação da integração.
Permissões
Apenas usuários com papel de administrador da organização (Org Admin) ou provedor de APIs (API Provider) podem publicar documentações em portais. Para saber mais, acesse a seção Papéis e permissões.
Parâmetros
Aqui estão os parâmetros para a publicação de uma documentação no portal:
- Portal: Obrigatório. Portal onde a documentação será disponibilizada.
- Versão da documentação: Obrigatório. Versão da documentação a ser publicada no portal.
Ao excluir a publicação de uma documentação de um portal, os usuários do portal deixarão de ter acesso a ela.