Struct ShopifyConfig 

pub struct ShopifyConfig { /* private fields */ }

Configuration for the Shopify API SDK.

This struct holds all configuration needed for SDK operations, including API credentials, OAuth scopes, and API version settings.

Thread Safety

ShopifyConfig is Clone, Send, and Sync, making it safe to share across threads and async tasks.

Key Rotation

The old_api_secret_key field supports seamless key rotation. When validating OAuth HMAC signatures, the SDK will try the primary key first, then fall back to the old key if configured. This allows in-flight OAuth flows to complete during key rotation.

Example

use shopify_sdk::{ShopifyConfig, ApiKey, ApiSecretKey};

let config = ShopifyConfig::builder()
    .api_key(ApiKey::new("your-api-key").unwrap())
    .api_secret_key(ApiSecretKey::new("your-secret").unwrap())
    .is_embedded(true)
    .build()
    .unwrap();

assert!(config.is_embedded());

Implementations

impl ShopifyConfig

pub fn builder() -> ShopifyConfigBuilder

Creates a new builder for constructing a ShopifyConfig.

Example

use shopify_sdk::{ShopifyConfig, ApiKey, ApiSecretKey};

let config = ShopifyConfig::builder()
    .api_key(ApiKey::new("key").unwrap())
    .api_secret_key(ApiSecretKey::new("secret").unwrap())
    .build()
    .unwrap();

pub const fn api_key(&self) -> &ApiKey

Returns the API key.

pub const fn api_secret_key(&self) -> &ApiSecretKey

Returns the API secret key.

pub const fn old_api_secret_key(&self) -> Option<&ApiSecretKey>

Returns the old API secret key, if configured.

This is used during key rotation to validate HMAC signatures created with the previous secret key.

pub const fn scopes(&self) -> &AuthScopes

Returns the OAuth scopes.

pub const fn host(&self) -> Option<&HostUrl>

Returns the host URL, if configured.

pub const fn api_version(&self) -> &ApiVersion

Returns the API version.

pub const fn is_embedded(&self) -> bool

Returns whether the app is embedded.

pub fn user_agent_prefix(&self) -> Option<&str>

Returns the user agent prefix, if configured.

pub fn deprecation_callback(&self) -> Option<&DeprecationCallback>

Returns the deprecation callback, if configured.

This callback is invoked when the SDK receives a response indicating that an API endpoint is deprecated.

Trait Implementations

impl Clone for ShopifyConfig

fn clone(&self) -> ShopifyConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ShopifyConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.