Site

The site object contains all the configuration of the site on the platform.

The site object is retrieved by calling the Site configuration endpoint. It contains general information about your site, a list of enabled features and settings for each, list of products available for purchase online, list of paywalls, their associated attributes and settings as well as payment gateway settings configured under your account.

General settings

AttributeDescription
account stringThe unique identifier of the account to which the site is associated.
default_currency stringThe default current associated to your account.
default_locale stringThe default local associated to your site.
ecommerce_enabled boolWhether Ecommerce feature is enable in your site settings.
name stringName of your site, as define in your settings.
link stringThe link this site is available on. This is used in email notifications and any other reference to the site.
logo arrayAttributes of the logo.
products arrayList of products available for purchase online, and associated attributes.
paywalls arrayList of paywalls, associated attributes and settings.
design_settings arrayIf defined, list of design configurations to apply to the default user interface.

Payment gateway settings

AttributeDescription
braintree_tokenization stringBraintree tokenization string, as defined in your gateway settings.
braintree_currency stringSupported Braintree currency, as defined in your gateway settings.
vantiv_gateway_settings arrayList of configuration settings for Vantiv payment gateway.
tap_gateway_settings arrayList of configuration settings for Tap payment gateway.
cybersource_gateway_settings arrayList of configuration settings for Cybersource payment gateway.

Features settings

Passwordless

The passwordless feature allows your customers to request a link that they can use to login without entering their email or password.

AttributeDescription
passwordless_enabled boolWhether Customer passwordless feature is enabled in your site settings.
passwordless_token_duration
int
If Customer passwordless feature is enabled, this is the link duration (in days).

Social logins

The social logins feature allows your customers to login with well-known identify providers.

AttributeDescription
google_app_id
string
If provided, the Google app ID defined in your site settings used for social login feature.
facebook_app_id
string
If provided, the Facebook app ID defined in your site settings used for social login feature.
auth0_base_url stringIf provided, the Auth0 Domain defined in your site settings used for social login feature.
auth0_client_id stringIf provided, the Auth0 Client ID defined in your site settings used for social login feature.

Security and fraud prevention

Pelcro offers various tools for security and fraud prevention, some of which are surfaced via the Site object.

AttributeDescription
security_key stringThis is the security key to use to initiate the verification process of end-user interaction on your website. This will be populated only if Risk Assessment feature is enabled.
email_verify_enabled boolWhether Customer email verification feature is enabled in your site settings.

Taxes

AttributeDescription
taxes_enabled boolWhether taxes are enabled under your account. Contact [email protected] for more information on how to enable this feature.
tax_inclusive boolIf enabled, Whether taxes are inclusive or exclusive. Contact [email protected] for more information on how to enable this feature.

Analytics

AttributeDescription
google_analytics_id stringIf provided, the Google analytics ID defined in your site settings.