Hello everyone!
I have tried browsing for this same question, but couldn't find it, if it's an existing problem and I could get a redirect - Thank YOU!
Thanks in advance for any support :)
On to the problem.
I'm trying to open an API's documentation:
But when I do, I just get a 404.
Any help will be greatly appreciated!
Thank you!
Hi José,
Check if your application is published and up to date. This API is probably not published on the server or some name has changed, such as the API or module name, for example.
Republish and test again.
The API is published and being consumed, with no issues.
It's just the documentation having this behavior.
Hi,
Most probably you just created the end point. But not published yet. Please publish the code once and then open documentation. It will work.
regards.
HI, @José Teixeira
Error appears when you created API and haven't published.
Make sure you have i published the module and click on Open Documentation.
Hi @José Teixeira
Publish of the Module is important to get the documentation because if we are not publish then the system treats it as a local or private API, and it won’t be available for external calls, documentation, or even testing. The published API makes the endpoint publicly available within the environment and accessible to authenticated consumers or applications that need to interact with it.
Regards ,
Rajat
4 times the same reply...
😔
Hi, the most obvious reason could be that the "Documentation" setting of the exposed REST API is set to No.
Fortunately it is checked to Yes!! Thank you for the reminder though!
Be sure to also check in Service Center whether the documentation is set to accessible:
I had not checked that, thank you!
But it is also enabled.
That's really weird. Because all the things that I can imagine are the problem are checked. What happens if you consume the API and specify the URL that causes the 404 in the browser inside Service Studio? Does it find it, or does it also give a 404?
Hi, just wanted to provide some sort of follow up on this. We found a way around this issue, although we're not sure why, we would be glad to hear your thoughts.
We were using the standard: https://<EnvironmentName>/<AppName>/rest/<IntegrationName>/ to check the documetation, but it wasn't working.
We tried a different aproach: https://<ServerIP>/<AppName>/rest/<IntegrationName>/
AND IT WORKED.
Any ideas why?
Is this a local server or a server in a private cloud? Or is it a standard OutSystems/Amazon cloud server?
I asked a question yesterday about using the URL in a REST consume, to see if it works server-to-server, did you already try that?
Are there any SEO rules in place with that AppName?
Hello @Kilian Hekhuis
It's hosted in a private cloud.
When trying to consume via REST in the same app, I get the same thing:
I'm not sure about the SEO rules. But if there were, wouldn't it make sense to also block me accessing the URL via IP?
I'm not too versed when it comes to SEO, but I was thinking that perhaps the specific URL would have been wrongly redirected or something. But anyway, it's a really weird case. Did you also create a support case for it?
I have not created a support case for it, no.
If I were you I'd do just that - perhaps it's a bug, perhaps there's some feature we missed. Make sure you give all relevant information, including what you've already checked, as otherwise they're going to ask all that :).