Code Locations
Quick Reference
Section titled “Quick Reference”Find code for integration-related functionality.
Repositories
Section titled “Repositories”| Repository | Purpose | URL |
|---|---|---|
| Retail API | Main backend, API integrations | web-service/api |
| Collector | File download service | integrations/collector |
| Morningstar | Security data sync | integrations/morningstar |
| Admin Center API | Admin backend | admin-center/api |
| PHP Packages | Shared libraries | php-libs/packages |
Retail API Directories
Section titled “Retail API Directories”API-based Integrations
Section titled “API-based Integrations”app/Integrations/├── ApiBased/│ ├── Connectors/ # Vendor API clients│ ├── Integrators/ # Sync orchestration│ ├── Requests/ # API endpoint definitions│ └── Plugins/ # Shared functionality├── {VendorName}/ # Vendor-specific code│ ├── Connector.php│ ├── Integrator.php│ └── Requests/SSO Controllers
Section titled “SSO Controllers”app/Http/Controllers/Sso/├── {VendorName}SsoController.php # Vendor-specific SSO handlers├── SamlController.php # Generic SAML handling└── ...Integration Commands
Section titled “Integration Commands”app/Console/Commands/├── Integration/│ ├── SyncCommand.php # Nightly sync│ ├── ImportCommand.php # Manual import│ └── ...Database Models
Section titled “Database Models”app/Models/├── Integration.php # integrations table├── IntegrationMapping.php # integration_mappings table├── IntegrationLog.php # Logging model└── ...Shared Libraries
Section titled “Shared Libraries”File-based Integration Library
Section titled “File-based Integration Library”php-libs/packages/libs/integrations-file-based/├── Parsers/ # Vendor file parsers├── Processors/ # Data processing└── ...Location: integrations-file-based
Collector
Section titled “Collector”collector/├── src/│ ├── Downloaders/ # SFTP download logic│ ├── Processors/ # File processing│ ├── Uploaders/ # S3 upload logic│ └── Finalizers/ # LATEST file generation├── config/│ └── vendors/ # Vendor configurations└── ...Key Files
Section titled “Key Files”| Purpose | Location |
|---|---|
| Integration routes | routes/api.php (search for “integration”) |
| OAuth callbacks | app/Http/Controllers/Integration/ |
| Sync scheduling | app/Console/Kernel.php |
| Integration config | config/integrations.php |
Database Tables
Section titled “Database Tables”| Table | Purpose |
|---|---|
integrations | Advisor-Vendor connections |
integration_mappings | Entity mappings |
integration_logs | Request/response logs |
securities | Security master data |
positions | Account positions |
S3 Paths
Section titled “S3 Paths”| Path | Content |
|---|---|
rightcapital-prd/integrations/{vendor}/ | Collector output files |
rightcapital-prd/logs/integration/{vendor}/ | File logs |
Environment Variables
Section titled “Environment Variables”Key environment variables for integrations:
| Variable | Purpose |
|---|---|
INTEGRATION_S3_BUCKET | S3 bucket for files |
{VENDOR}_CLIENT_ID | OAuth client ID |
{VENDOR}_CLIENT_SECRET | OAuth client secret |
{VENDOR}_API_URL | Vendor API base URL |