GetPartnerStorefront

Return the authenticated active Partner storefront identity, VAT, contact, social, colour and default-currency settings without exposing credentials or payment configuration.

Endpoint: https://sive.host/modules/addons/shapi/sh-api.php

Method: POST using application/x-www-form-urlencoded.

Read-only action. Access is limited to directly owned records or explicitly assigned Partner-managed client services after both relationships are verified.

Important behavior

• Administrator-controlled storefront capability flags are visible but cannot be changed by this action.

Request parameters

Example request

Set the four environment variables from the authenticated SHAPI page. Do not put credentials in source control or URLs.

curl --request POST 'https://sive.host/modules/addons/shapi/sh-api.php' \
  --user "${SHAPI_HTTP_USER}:${SHAPI_HTTP_PASSWORD}" \
  --header 'Accept: application/json' \
  --data-urlencode "action=GetPartnerStorefront" \
  --data-urlencode "api_key=${SHAPI_API_KEY}" \
  --data-urlencode "api_secret=${SHAPI_API_SECRET}"

Response

SHAPI always returns JSON. Check result; panel responses can vary by the server module and DirectAdmin version.

{
    "result": "success",
    "message": {
        "action": "GetPartnerStorefront",
        "data": "Panel- or action-specific response"
    }
}

Common errors

• Unauthorized access!: source IP or HTTP Basic authentication failed.
• Invalid API Key or secret.: the customer key is wrong, disabled, or deleted.
• Unable to retrieve an active service owned by this client.: the service is inactive or belongs to another client.
• Missing required parameters.: one or more required fields were omitted.

SHAPI documentation version 2.0 — generated from the current endpoint contract.