An explanation of how the “Bootstrap_Server” node in the config.xml is used.
So as to maintain API security levels, there is a need for “server-to-server” API communications as well as “browser-to-server” communications.
This means that programs on the server on which the IC_CE_Pro files are installed will need to communicate with the server programs on the Interview Coordinator (IC) API server.
For example, when IC _CE_Pro files are installed on a PHP server, then to create a new candidate record in the IC database, the Javascript in the IC_CE_Pro html files will call a server program function called “createCandidate” which is located in a script file called “api.php”.
When the IC_CE_Pro files are unzipped and copied to a webserver, the api.php file is physically located in a sub-directory called – ./php_api_program/api/Internal
However, because the IC_CE_Pro files can be installed on different types of webserver and in different physical locations, the Javascript needs to know how to access the “createCandidate” function for each specific installation.
Therefore the Javascript logic will first read the value of the Bootstrap_server>XXXXXXX</Bootstrap_server> node in the config.xml file and then append the following value – “api/Internal/createCandidate” to the value just read.
The value of the Bootstrap_server>XXXXXXX</Bootstrap_server> node must therefore correspond to wherever the IC_CE_Pro files have been installed.
For example : assuming the IC_CE_Pro files have been copied to the Root directory of a webserver, the Bootstrap_server value might equal – http://localhost:8080/php_api_programs
When the javascript appends the /api/internal/createCandidate string to the end of the Bootstrap_server value the full path will be :
http://localhost:8080/php_api_programs/api/internal/createCandidate
This will therefore correctly call the createCandidate program function which creates a new candidate record.