Overview
Introduction to entry points
Introduction to Entry Points
All entry points into the Sugar application are pre-defined to ensure that proper security and authentication steps are applied consistently across the entire application. The main entry points to note are:
- ./cron.php - Used by the Windows Scheduler Service or the cron service on Linux and Unix for executing the Sugar Scheduler periodically
- ./index.php - Default entry point into the Sugar application
- ./install.php - Used for initial install of the Sugar application
- ./soap.php - Entry point for all v1 SOAP calls. This entry point is deprecated and should not be used for API development
- ./service/{api version}/soap.php - Entry point for v2 - v4_1 SOAP calls
- ./service/{api version}/rest.php - Entry point for for v2 - v4_1 REST calls
All stock entry points can be found in ./include/MVC/Controller/entry_point_registry.php.
Accessing Entry Points
Available entry points can be accessed using a URL pattern as follows:
http://{sugar url}/index.php?entryPoint={entry point name}
The entry point name will be the specified index in the $entry_point_registry array. Access to this entry point outside of sugar will be dependent on the auth parameter defined in the $entry_point_registry array as well. The following section will outline creating custom entry points.
