API Credentials
This page exists for older integrations and custom routing setups. In current installs it may not be exposed in the default navigation, but existing projects can still rely on the stored values.
API key and secret
Use the key and secret pair for integrations that still authenticate directly against the plugin.
Access token
Store short-lived tokens here when an integration needs a token instead of the full key and secret pair.
Host name
Keep the host value aligned with the public storefront host when the integration validates callbacks or absolute URLs.
Developer reference
Access credential values from the plugin settings model using these field names:
| Field | PHP property | Notes |
|---|---|---|
| API Key | $settings->apiKey | Key or account SID for direct authentication |
| API Secret Key | $settings->apiSecretKey | Secret paired with apiKey |
| Access Token | $settings->accessToken | Short-lived token for token-based auth |
| Host Name | $settings->hostName | Storefront host used for callback validation |
$settings = \yui\craft\Plugin::getInstance()->getSettings();
$apiKey = $settings->apiKey;
$apiSecretKey = $settings->apiSecretKey;
$accessToken = $settings->accessToken;
$hostName = $settings->hostName;