No módulo Studio, na área de Serviçosvocê encontra a aba “Integrações de API”, nessa área, você poderá cadastrar APIs com o objetivo de comunicar com as APIs externas, acessando assim informações de ambientes externos. É importante ressaltar que nessa área é configurada a interface de chamada de serviço, porém, para o funcionamento desse recurso é necessário configurar o modelo de processo, incluindo esse serviço. Para acessar essa área, selecione Serviçose clique na aba “Integrações de API”.
...
Você poderá mapear as informações de seu interesse, escolhendo uma ou duas informações que gostaria de receber e configurar. Para realizar essa ação, basta clicar em “Response Output” e depois em “Adicionar parâmetros” e preencher o “Nome” com o nome do atributo que queremos como retorno para uso no processo, por exemplo. O “Path”, caminho da informação dentro da estrutura do retorno e o “Tipo” de informação que está sendo mapeada. O campo “Collection ID” receberá o nome da coluna mapeada, onde a collection é a lista que contém as informações que estão sendo mapeadas. E o “Valor Padrão” de retorno, caso o serviço não retorne a informação para a coluna mapeada. Feita essa configuração de acordo com o seu serviço e suas necessidades, você deverá clicar em “Salvar”, você poderá também testar a integração da API.
Para testar se a integração de API está correta e se está retornando o que se espera, basta clicar no botão “Testar API” e depois clicar no botão “Executar teste”.
...
Uma versão nova será criada, é importante destacar que essa versão (V.2) ainda não está publicada, então você poderá fazer as modificações necessárias, clicar em “Salvar” e depois clicar em “Publicar”.
...
Vale ressaltar que, ao versionar a API, a nova versão (V.2) inicialmente não contém os campos "Response Output", pois eles podem ser alterados durante o versionamento. Para aplicar os campos da versão V.1 na V.2, você deve alternar a visualização da API e retornar para a integração versionada (V.2).
Você ainda tem a opção de excluir uma API que não deseja mais manter no cadastro ou suspender a sua atividade.
...