Learn how to publish and access an API using the internal gateway on the Digibee Integration Platform.
Last updated
Was this helpful?
On the Digibee Integration Platform, you can publish your pipelines for internal or external use:
Internal use: The API is available only within your cluster’s internal gateway, allowing access by other pipelines in your realm or through a VPN.
External use: The API is accessible over the internet, enabling interaction with external applications and services.
You can use the following triggers to configure your API: HTTP, HTTP File, and REST.
Follow the steps below to enable and use an Internal API.
To enable the Internal API in your realm, contact Digibee Customer Support.
The team will configure:
Hostname: {{realmname}}.digibee.internal
Ports:
7070 (Production)
9090 (Test)
To configure the pipeline to use the Internal API:
Enable Internal API and API Key in the trigger configuration form.
Assign the pipeline to an API Key.
Deploy the pipeline on the Run page.
Open the Deployment details card for the pipeline and expand the trigger configuration section to find the endpoint in the following format:
Once the pipeline is deployed and the endpoint is available, you can consume it in two ways:
Using a VPN
Locally from other pipelines (without a VPN)
By default, it’s not possible to consume the endpoint locally from other pipelines (without a VPN) on the Dedicated SaaS model.
To successfully consume an endpoint via a VPN, ensure that Phase 2 of Digibee is properly configured in your network. The service making the request must be within the IP range mapped to Digibee’s Phase 2.
Before making a request, confirm that:
Phase 2 of Digibee is declared in your network.
The API consumer’s IP range is mapped in Digibee’s Phase 2.
Once Phase 2 mappings are configured, use the following format to call the endpoint:
Use HTTP instead of HTTPS.
If you find issues while making the request, verify the following:
The Internal API is available in your realm.
Your Phase 2 mapping is correctly configured in Digibee.
Phase 2 of Digibee is declared in your network.
You are using HTTP instead of HTTPS.
By default, it’s not possible to consume the endpoint locally from other pipelines (without a VPN) on the Dedicated SaaS model.
To consume this endpoint locally, replace this part: {replace with Digibee internal host}
with the appropriate internal host and port. See this example:
Host: dgb-support-lab.digibee.internal
Port (Test): 9090
The following URL will be used to access the endpoint:
Use HTTP instead of HTTPS.
You can trigger this endpoint within a pipeline using one of the following connectors:
Additionally, an external application can access it if a VPN connection is established with your realm.
Example: Using the REST connector
Here's an example of how to configure the REST connector to call this internal API:
Connector’s configuration:
Output:
