We have a secure gateway configured in our tenant and we are successfully consuming our outside service's API's through it, but now we are facing a situation where we need to expose an API through the same secure gateway (or if anyone has other ideas on how to enable our outside service to trigger an action in our app through the secure gateway, I am open to all ideas).
I can't seem to find any documentation on how to do it. Does anyone have a clue on how could I achieve this? Or even have a nudge towards documentation that could help me doing this?
Best,
Jenni
To expose an API through the same secure gateway in OutSystems, follow these steps:
1. Create a REST API: Build a REST API within your OutSystems application using Service Studio.
2. Configure Secure Gateway: Configure your secure gateway to allow incoming traffic to this API endpoint. This involves setting up routing rules and security policies within the gateway.
3. Authentication: Implement authentication mechanisms such as API keys, OAuth, or other secure methods to control access to your API.
4. Testing and Documentation: Thoroughly test the API to ensure functionality and security. Document the API endpoints, parameters, and responses for external service integration.
For detailed guidance, refer to OutSystems documentation on [exposing REST APIs] https://success.outsystems.com/documentation/outsystems_developer_cloud/integration_with_external_systems/exposing_rest_apis/ .
Thank you Youssef,
We are using ODC so some of the details in the steps do not apply.
Specifically, how would one configure the secure gateway (using the cloud connector) to allow inbound traffic aswell?
If you have any more specific steps, they would be very much appreciated!
As I understand it, you are using Private Gateway and Cloud Connect to consume some services from your private cloud. Now, your expectation is to use the same channel to consume ODC services in your private cloud. I don't think that is possible, as Cloud Connect is not listening to any particular port for devices on your private network to connect to.
By the way, your application is already open to the internet unless you IP filter it. So, your applications should be able to access it, provided they have internet access.
Thank you for your answer Siya,
We are using the private gateway to consume some services from our integration system and because this app handles sensitive data we have to transport it through the secure gateway. But now we have a need to trigger something in our app from the integration system and because there is sensitive data there in the trigger it would also have to go through the secure gateway (or some other secure way).
But since there is very little documentation about the secure gateway it is hard to figure out how to do it :D
ODC Private gateway is intended to connect to your On prem/Internal apis from ODC. And not the other way around.If the requirement is to connect to the APIs built in your ODC, they would already exposed public and could be used by your internal systems unless you are restricting those via IP filtering feature.