Facility Connect API
I am having problems getting the Facility Connect API to work with the eSchools learning platform. I have updated the api.xml with the settings that were given to me by the eSchools learning platform and I keep getting the 404 error message. The api.xml settings have been checked and are correct. Can anyone help me to resolve this problem as Link2ict do not offer any support on this?
I can see form your screenshot you don't have a version number on the API. To resolve this issue all you need to do it stop your ePortal services and delete/remove the API folders located in your webapps folder. When you start the services back up these folders will be rebuilt. If you find it doesn't work at this point just stop and start the services a second time (with out removing the API folders).
Scott @ Serco
Thanks alot Scott_Serco. It's working now! I can't believe the fix was something so simple. I have been trying to get the Facility Connect API to work for weeks. Your a life saver! Finally the eSchools learning platform can be installed and I can get the Teachers and SMT of my back.:D
Sorry, Scott_Serco I still need more help it looks like something is still not working with the API. I have been advised by eSchools that the following URLs below should be working and I get a HTTP 500 error when I click on the URLs on the admin server. Any ideas as to what the problem is and a potential fix.
The API will only work over https, this is normally port 443 in IIS and 8443 in TomCat. The top link you have provided would only work if IIS has been configured to use port 80 for HTTPS but port 80 is the default port for HTTP. The bottom link wouldn't work as it is unsecured and using port 8080, the default http port for TomCat.
If you're using the default setup for IIS and TomCat I would expect the following links:
Over IIS (when SSL is setup) -- https://127.0.0.1/API/services/WebService
Over TomCat -- https://127.0.0.1:8443/API/services/WebService
I have not included the port on the first link because by default it'll use port 443. You will also need to ensure your loopback address (127.0.0.1) is included in the API.XML file localed in \Facility\ePortal\conf\Catalina\localhost\
The loopback address is already in the API.XML file as shown below:-
<?xml version="1.0" encoding="UTF-8" ?>
<Valve className="org.apache.catalina.valves.RemoteAddrVa lve" allow="127.0.0.1,10.123.72.40,10.123.72.51,87.198. 228.134" />
When I go to https://127.0.0.1/API/services/WebService I get the following message:-
Server Error 500 - Internal server error.
There is a problem with the resource you are looking for, and it cannot be displayed.
When I go to https://127.0.0.1:8443/API/services/WebService I get the following message:-
The website cannot display the page
Most likely causes:
•The website is under maintenance.
•The website has a programming error.
What you can try:
Refresh the page.
Go back to the previous page.
I assume IIS has been installed with the default setup by Link2ICT. My knowledge of IIS is pretty much non-existent.
What would happen if you try the splash screen, you can then link to other parts of the API from here -
Also the address used in the links needs to be
My apologies, I should have picked up on that when I replied this morning.
The Link2ICT setup is the same as the Serco setup, with the exception that the option to only allow connections over https is enabled and the 403.4 error message that tells you that is changed to a redirect to point to the https side of things.
Originally Posted by pbaddhan
The certificates installed for all Birmingham schools are wildcards for *.misportal.net so you will get certificate warnings when attempting to load pages via the IP address.
Thanks Scott_Serco and ChrisJ. It turns out that the eSchools.xml soapwsdl section of the file was not configured correctly.
<soapwsdl>https://127.0.0.1/API/services/WebService?wsdl</soapwsdl> - old configuration
<soapwsdl>https://127.0.0.1:8443/API/services/WebService?wsdl</soapwsdl> - new/working configuration
Came across this topic while trying to sort a very similar problem with getting Vivo rewards system to connect to the Facility Connect API - we also have Facilty installed by Link2ICT who say they do not support the Connect API. Though its been working for nearly two years and only stopped after the latest update on 10th May.
The problem is that after deleting the API folder, then restarting the services to rebuild it - I cannot connect locally to the splash screen using
https://127.0.0.1:8443/API/ as it returns a 404 error,
though if I connect to
https://127.0.0.1:8443/api/ it retrns the splash screen OK.
Looking in the \Facility\ePortal\webapps folder the api folder is in lowercase, and if I try to rename it it wont allow me, even with Admin rights as its in use.?
Vivo is trying to connect to
and are getting a 404 error as well. Though it was working before the update on 10th May.
We are running IIS which I am not that clued up on, so I am struggling to fix this!
Screenprint shows that Connect APi is running locally, and the API.xml file in ePortal\conf\Catalina\lovalhost is correct ( as it hasn't changed since before the update) and the ip addresses for Vivo are correct.
Link2 ICT say they don't support Connect API and have suggested we contact Serco direct, I just wondered if anyone else had any suggestions or advice before I try them?
Did you try stopping the ePortal services (eportal, dataserver & IIS) then renaming the folder?
Originally Posted by TheBinMan
I know the Apache side of things is case sensitive so that could be the problem. Odd how the folder has been created as lower case since the delete & rebuild usually creates the folder as "API" rather than "api".
Thanks. We've I've just tried stopping the dataserver abd eportal services, renamed the folder to API and its all working ok.
Something as simple as that has caused us hours of problems.
No idea why it recreates the folder in lower case when theres an API.war file in upper case. Guess its just a 'feature' of the last Facility update we ran!