General Documentation

Sunsky API Integration

Last updated: Jan 06, 2026

Sunsky API Integration

Technical guide for the Sunsky OpenAPI integration.

Overview

The module integrates with SUNSKY OpenAPI to provide:

  • Product catalog access
  • Real-time pricing
  • Stock availability
  • Order placement
  • Order tracking

API Credentials

Getting Credentials

  • Visit Sunsky Open Platform
  • Register a business account
  • Apply for API access
  • Wait for approval
  • Get your App Key and App Secret
  • Configuring Credentials

  • Go to Sunsky StoreSettings
  • Enter App Key and App Secret
  • Click Test Connection
  • Save settings
  • Signature Algorithm

    All API requests are signed using MD5:

  • Add key parameter
  • Sort parameters by key name
  • Concatenate VALUES only
  • Append @ + secret
  • MD5 hash the result
  • // Example
    

    $params = ['key' => 'abc', 'page' => '1']; ksort($params); $values = implode('', array_values($params)); // "abc1" $signature = md5($values . '@' . $secret);

    Available Endpoints

    EndpointPurpose
    category!getChildren.doGet categories
    product!search.doSearch products
    product!getByItemNo.doProduct details
    order!getCountries.doShipping countries
    order!getPricesAndFreights.doCalculate shipping
    order!createOrder.doPlace order
    order!getOrderList.doList orders
    order!getOrderDetails.doOrder details
    order!getBalance.doAccount balance

    Rate Limits

    • General: 100 requests/minute
    • Search: 30 requests/minute
    • Orders: 10 requests/minute
    The module handles rate limiting automatically.

    Error Handling

    Common error codes:

    CodeMeaning
    1001Invalid signature
    1002Invalid API key
    2001Product not found
    3001Invalid country
    4001Insufficient balance