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

Update marketplace credentials

POST
/api/merchants/platforms/{platformId}/credentials
Updates API credentials for marketplaces that use API key authentication instead of OAuth.
Supported Platforms:
WooCommerce (requires API key, API secret, store URL)
Custom integrations
Note: For OAuth-based platforms (Chowdeck, Bumpa, etc.), use the connect endpoint instead.

Request

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

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Credentials updated and connection activated
Body

🟠400
🟠401
🟠404
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://api.dev.opensylo.com/api/merchants/platforms//credentials' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "apiKey": "ck_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "apiSecret": "cs_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "storeUrl": "https://mystore.com"
}'
Response Response Example
{
    "platformId": "chowdeck",
    "connectionStatus": "NOT_CONNECTED",
    "isActive": true,
    "lastSyncAt": "2024-01-20T15:30:00.000Z",
    "metrics": {
        "totalSales": 2500000,
        "totalOrders": 456,
        "lastOrderDate": "2024-01-20T14:25:00.000Z"
    }
}
Modified at 2025-12-30 08:04:15
Previous
Get connection status
Next
Handle OAuth callback
Built with