Skip to content
RightCapital Knowledge Base

代码位置

快速参考

Section titled “快速参考”

按功能查找 integration 相关代码。

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 库

Section titled “File-based Integration 库”
php-libs/packages/libs/integrations-file-based/
├── Parsers/                         # Vendor 文件 parser
├── Processors/                      # 数据处理
└── ...

Location: integrations-file-based

Collector

Section titled “Collector”
collector/
├── src/
│   ├── Downloaders/                 # SFTP 下载逻辑
│   ├── Processors/                  # 文件处理
│   ├── Uploaders/                   # S3 上传逻辑
│   └── Finalizers/                  # LATEST 文件生成
├── config/
│   └── vendors/                     # Vendor configurations
└── ...

关键文件

Section titled “关键文件”
用途 位置
Integration routes routes/api.php（搜索 “integration”）
OAuth callbacks app/Http/Controllers/Integration/
Sync scheduling app/Console/Kernel.php
Integration config config/integrations.php

Database Tables

Section titled “Database Tables”
表 用途
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

Source

Section titled “Source”