Passar para o conteúdo principal
Todas as coleçõesTriggers
Entenda como utilizar API Interna através de VPN na Digibee Integration Platform
Entenda como utilizar API Interna através de VPN na Digibee Integration Platform

Este artigo aborda como publicar e consumir uma API no gateway interno da Digibee.

Guilherme Jola Ferreira avatar
Escrito por Guilherme Jola Ferreira
Atualizado há mais de 8 meses

Na Digibee, é possível publicar os pipelines de sua organização para uso interno e/ou externo. Para uso interno, a API é disponibilizada exclusivamente no gateway interno do seu cluster, permitindo o acesso por outros pipelines do seu realm ou via VPN. Já para uso externo, a API fica acessível também pela internet, permitindo a interação de aplicativos e serviços externos.

Os triggers que atualmente possuem essa funcionalidade são: HTTP, HTTP-FILE e REST.

Habilitando API interna no realm

A API interna não é habilitada por padrão no realm, para fazê-lo entre em contato com o time de suporte da Digibee. (é necessário habilitar uma única vez no realm para poder utilizar em seus pipelines).

Por padrão será disponibilizado um hostname {{nomedorealm}}.digibee.internal e as portas 7070 (PROD) e 9090 (TEST).

Configurando API interna no pipeline (trigger REST)

Vamos utilizar o cenário abaixo como exemplo:

Realm: dgb-support-lab

Host: dgb-support-lab.digibee.internal

Porta (test): 9090

Porta (prod): 7070

Nome do Pipeline: test-api-internal

Configuramos o trigger REST no pipeline test-api-internal. (lembre de atribuir esse pipeline a uma API Key).

Feito o deploy do pipeline em ambiente de TEST, será disponibilizado o seguinte endpoint:

https://{replace with Digibee internal host}/pipeline/dgb-support-lab/v1/test-api-internal

O consumo desse endpoint pode ser feito via VPN, ou, localmente por outros pipelines, nesse segundo caso não é necessário ter VPN estabelecida com a Digibee, a forma de consumir o endpoint difere nas duas opções citadas, vamos aos detalhes:


Consumindo via VPN:

É preciso que a Phase 2 da Digibee esteja declarada na sua rede, e que o serviço que fará o consumo esteja dentro do range da sua Phase 2 que está mapeada na Digibee, por exemplo:

Uma vez que os mapeamentos de Phase 2 estejam configurados, o endpoint deverá ser chamado da seguinte forma:

http://10.255.0.2:9090/pipeline/dgb-support-lab/v1/test-api-internal

Checklist que você pode fazer através do chat para realizar a chamada via vpn:

Verificar se a Api Interna está disponível no seu realm.
Verificar se a sua Phase 2 que mantém o consumidor da API está mapeada na Digibee.
Phase 2 da Digibee deve estar declarada na sua rede.
Utilizar HTTP e não HTTPS.

Consumindo localmente (sem VPN):

Agora para consumir esse Endpoint devemos substituir o {replace with Digibee internal host} pelo host interno juntamente com a porta.

Host: dgb-support-lab.digibee.internal
Porta (test): 9090

http://dgb-support-lab.digibee.internal:9090/pipeline/dgb-support-lab/v1/test-api-internal

Utilize HTTP ao invés de HTTPS.


Como consumir uma API Interna:

Agora você já consegue acionar o seu Endpoint através de um pipeline utilizando o componente REST V2 ou Pipeline Executor, assim como por alguma aplicação externa, desde que possua uma VPN estabelecida com seu realm.

Segue um exemplo utilizando o componente REST V2.

Respondeu à sua pergunta?