OpenSylo Backend API
  1. Marketplace Connections
OpenSylo Backend API
  • API Info
    • API Information
      GET
  • Health
    • HealthController_checkHealth
      GET
    • HealthController_ping
      GET
  • Marketplace Connections
    • Get available marketplaces
      GET
    • Get marketplace catalog
      GET
    • Get marketplace details
      GET
    • Initiate marketplace connection
      POST
    • Disconnect from marketplace
      POST
    • Get connection status
      GET
    • Update marketplace credentials
      POST
    • Handle OAuth callback
      POST
  • Merchant Authentication
    • Register a new merchant account
      POST
    • Authenticate merchant
      POST
    • Verify email address
      POST
    • Resend verification email
      POST
    • Request password reset
      POST
    • Reset password
      POST
    • Change password
      POST
    • Refresh access token
      POST
    • Logout
      POST
    • Get current user profile
      GET
  • MerchantKyc
    • MerchantKycController_getOnboardingStatus
      GET
    • MerchantKycController_getKycProgress
      GET
    • MerchantKycController_sendOtp
      POST
    • MerchantKycController_verifyOtp
      POST
    • MerchantKycController_updateBusinessInfo
      PUT
    • MerchantKycController_addDirector
      POST
    • MerchantKycController_addBulkDirectors
      POST
    • MerchantKycController_uploadDocument
      POST
    • MerchantKycController_submitKyc
      POST
    • MerchantKycController_searchBusinessTypes
      GET
    • MerchantKycController_getBusinessCategories
      GET
    • MerchantKycController_getDocumentTypes
      GET
  • Merchants
    • Create a new merchant
    • Get all merchants
    • Get a merchant by ID
    • Update a merchant
    • Delete a merchant
  • Marketplace Data Ingestion
    • Submit Merchant Data
    • Submit Bulk Merchant Data
    • Get Merchant Credit Score
    • Health Check
  • Marketplace Dashboard
    • Complete Marketplace Registration
    • Marketplace Dashboard Login
    • Get OAuth Credentials
    • Regenerate Client Secret
    • Get Current User
    • Invite Marketplace (Admin)
  • OAuth 2.0
    • OAuth Authorization Endpoint
    • Process Authorization Decision
    • Token Endpoint
    • Revoke Token
    • Client Metadata
  • OAuth Authentication
    • Login Page
    • Login Submit
    • Signup Page
    • Signup Submit
    • Logout
  • Lenders
    • Create a new lender
    • Get all lenders
    • Get a lender by ID
    • Update a lender
    • Delete a lender
  • Schemas
    • PlatformDto
    • PlatformConnectionMetadataDto
    • PlatformConnectionInfoDto
    • PlatformListResponseDto
    • ConnectionInitResponseDto
    • ConnectionMetricsDto
    • ConnectionStatusResponseDto
    • DisconnectResponseDto
    • PlatformCatalogResponseDto
    • ConnectPlatformDto
    • DisconnectPlatformDto
    • PlatformCredentialsDto
    • MerchantSignupDto
    • SignupResponseDto
    • MerchantLoginDto
    • LoginResponseDto
    • MerchantVerifyEmailDto
    • EmailVerificationResponseDto
    • MerchantResendVerificationDto
    • GenericSuccessResponseDto
    • MerchantForgotPasswordDto
    • MerchantResetPasswordDto
    • MerchantChangePasswordDto
    • RefreshTokenDto
    • UserProfileResponseDto
    • OtpVerificationDto
    • BusinessKycDto
    • DirectorInfoDto
    • BulkDirectorInfoDto
    • DocumentUploadDto
    • CreateMerchantDto
    • UpdateMerchantDto
    • MarketplaceDataCaptureDto
    • BulkMarketplaceDataCaptureDto
    • CompleteMarketplaceRegistrationDto
    • MarketplaceLoginResponseDto
    • MarketplaceLoginDto
    • MarketplaceCredentialsResponseDto
    • RegenerateSecretResponseDto
    • InviteMarketplaceDto
    • MarketplaceInvitationResponseDto
    • CreateLenderDto
    • UpdateLenderDto
  1. Marketplace Connections

Get available marketplaces

GET
/api/merchants/platforms
Retrieves all available marketplaces/platforms with their connection status for the authenticated merchant.
Use Cases:
Display a list of available integrations in the merchant dashboard
Show which platforms the merchant is currently connected to
Help merchants discover new platforms to integrate with
Connection Status Values:
NOT_CONNECTED - Platform available but not connected
PENDING - Connection in progress (OAuth flow started)
CONNECTED - Successfully connected and syncing data
DISCONNECTED - Previously connected but now revoked
FAILED - Connection attempt failed

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or

Responses

🟢200
application/json
List of marketplaces with connection status retrieved successfully
Body

🟠401
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.dev.opensylo.com/api/merchants/platforms' \
--header 'Authorization: Bearer <token>'
Response Response Example
{
    "platforms": [
        {
            "platform": {
                "id": "chowdeck",
                "name": "chowdeck",
                "displayName": "Chowdeck",
                "description": "Food delivery platform that helps restaurants sell meals online and reach more customers.",
                "type": "FOOD_DELIVERY",
                "logo": "/logos/chowdeck.png",
                "website": "https://chowdeck.com",
                "status": "PENDING",
                "features": [
                    "Online food ordering",
                    "Delivery management",
                    "Real-time order tracking"
                ],
                "requirements": [
                    "Valid business registration",
                    "Food service license",
                    "Bank account"
                ]
            },
            "connectionStatus": "NOT_CONNECTED",
            "connectedAt": "2024-01-15T10:00:00.000Z",
            "lastSyncAt": "2024-01-20T15:30:00.000Z",
            "connectionId": "conn_abc123",
            "metadata": {
                "storeName": "Yakoyo Lekki Store",
                "storeId": "store_456",
                "accountEmail": "store@example.com"
            }
        }
    ],
    "totalPlatforms": 8,
    "connectedCount": 2,
    "availableCount": 6
}
Modified at 2025-12-30 08:04:15
Previous
HealthController_ping
Next
Get marketplace catalog
Built with