Configuration

Create the user account and API client SureBright needs in your SFCC Account Manager, and share the credentials securely, for both the Full Business Manager Access and API-Only Access paths.

On this page you give SureBright the access it needs to your SFCC instance. You create a user account and an API client in Account Manager, then share the credentials securely. What you create depends on the path you chose in the Integration Guide.

Your pathWhat you do on this pageWhat happens next
Full Business Manager Access (recommended for most stores)Create a SureBright user account, create an API client, share the credentials.SureBright handles the technical configuration while you focus on business requirements.
API-Only Access (for teams with SFCC developers)Create an API client, share the credentials and your site details.SureBright sends your development team the integration package, and your team deploys it.

Before you start: you need Account Manager access that lets you create users and API clients. If you do not have it, see the FAQs.


Set up Full Business Manager Access#

This path gives SureBright comprehensive access to your SFCC environment, so the SureBright team can handle all technical configuration.

This approach requires granting SureBright administrative access to your SFCC Business Manager. All activities will be logged and auditable.

Create the SureBright user account#

Create a dedicated SFCC user account for SureBright, with the roles it needs to manage the integration.

  1. Access Account Manager

    • Log into your SFCC Account Manager (separate from Business Manager)

    • Navigate to Administration → Users and Roles

    • Click "Add User" button to create a new user account SFRA Add User

  2. Configure User Details

    • Username: surebright-integration (must be unique)

    • Email: Use the email address provided by your SureBright representative

    • First Name: SureBright

    • Last Name: Integration

    • Password: Create a strong password (you'll share this securely with SureBright)

    • Status: Set to "Active" to enable immediate access

  3. Assign Required Roles In the "Roles" section, select these specific roles:

    • Administrator: Provides full access to Business Manager configuration, cartridge management, and system settings

    • API User: Enables programmatic access to SFCC APIs for data synchronisation

    • Job Manager: Allows import/export operations and job management for data sync processes

  4. Verify and Save

    • Review all user details and role assignments

    • Click "Save" to create the user account

    • Note the username and password for secure sharing with SureBright

Security Note: This user account will have administrative access to your SFCC instance. Only share credentials through secure, encrypted channels and verify the recipient's identity before sharing.

Create the API client for SureBright#

Create an API client so SureBright can work with your SFCC instance to sync data and manage the integration.

  1. Access API Settings in Account Manager

    • In your Account Manager, navigate to Administration → API Settings

    • Click "Create API Client" button

    • You'll need Account Manager administrative access to perform this step

  2. Configure Client Settings Fill in the following information:

    • Client Name: SureBright Integration

    • Client Type: Select "Public" (this allows the client to be used by external applications)

    • Description: API access for SureBright Product Protection integration

    • Redirect URI: Leave blank (not required for this integration type)

SFRA API Client

  1. Assign Required OAuth Scopes In the "Scopes" section, check the following boxes to grant necessary permissions:

    • sfcc.catalogs.rw - Read/Write access to product catalogs (allows product data sync)

    • sfcc.products.rw - Read/Write access to product data (enables product management)

    • sfcc.orders.rw - Read/Write access to order information (for warranty order processing)

    • sfcc.custom-objects.rw - Read/Write access to custom objects (for warranty data structures)

    • sfcc.jobs.rw - Read/Write access to job management (for data synchronisation jobs)

  2. Save and Retrieve Credentials

    • Click "Save" to create the API client

    • Important: Copy and securely store these values immediately:

      • Client ID: Unique identifier for API authentication (you'll need this)

      • Client Secret: Secret key for API authentication (you'll need this)

      • Organization ID: Found in Administration → Organization → Organization Settings

      • Realm: Part of your SFCC URL (e.g., if URL is https://your-realm.demandware.net, realm is your-realm)

      • Short Code: Your site identifier (found in Administration → Sites → [Your Site] → Settings)

Finding Your Organization Details: If you're unsure about Organization ID, Realm, or Short Code, refer to the FAQ section in the FAQs Page for detailed instructions.

Share the credentials securely#

Send SureBright these values so it can connect to your SFCC instance:

Client ID: [Your Client ID]
Client Secret: [Your Client Secret]
Organization ID: [Your Organization ID]
Realm: [Your Realm]
Short Code: [Your Short Code]

When you share them:

  • Use encrypted communication channels (encrypted email or secure file sharing)

  • Never share credentials via unsecured email or chat platforms

  • Consider using a password manager or secure note-sharing service

  • Verify the recipient's identity before sharing sensitive information

These credentials provide access to your SFCC instance. Treat them as sensitive business information and ensure they are shared only with authorised SureBright personnel.


Set up API-Only Access#

Choose this path if you have a dedicated SFCC development team and prefer to keep full control over your SFCC environment.

This approach requires your development team to have experience with SFCC cartridge deployment, job management, and custom object configuration.

Create an SFCC API client#

Your development team creates an API client so SureBright can support the integration and guide the data synchronisation.

  1. Access Account Manager

    • Navigate to Account Manager → Administration → API Settings

    • Click "Create API Client"

  2. Configure API Client

    Client Name: SureBright Integration
    Client Type: Public
    Description: API access for SureBright Product Protection integration support
  3. Assign Required OAuth Scopes

    sfcc.catalogs.rw     - Read/Write access to product catalogs
    sfcc.products.rw     - Read/Write access to product data
    sfcc.orders.rw       - Read/Write access to order information
    sfcc.custom-objects.rw - Read/Write access to custom objects
    sfcc.jobs.rw         - Read/Write access to job management
  4. Document Credentials

    • Securely store all generated credentials

    • Prepare for secure sharing with SureBright team

Share your credentials and site details#

Send SureBright the credentials and the site configuration details below.

API Credentials:
- Client ID: [Your Client ID]
- Client Secret: [Your Client Secret]
- Organization ID: [Your Organization ID]
- Realm: [Your Realm]
- Short Code: [Your Short Code]

Site Configuration:
- Inventory List ID: [Your Inventory List ID]
- Pricebook ID: [Your Pricebook ID]
- Site ID: [Your Site ID]

Before you send them:

  • Ensure inventory list and pricebook are properly assigned to your site

  • Verify all site configurations are complete and active

  • Confirm API client has been tested and is functional

Share this information only through secure, encrypted channels. Verify the recipient's identity before sharing sensitive credentials.

What SureBright sends your development team#

On the API-Only Access path, SureBright provides your development team with the integration files and detailed technical documentation for SFCC deployment. The package contains:

  1. SureBright Integration Cartridge

    • Complete SFCC cartridge with warranty functionality

    • Compatible with your SFCC version

    • Includes all necessary controllers, models, and templates

  2. Data Import XML Files

    • Job Import XMLs: Product sync and order sync job configurations

    • Custom Fields XML: Line item and product attribute definitions

    • Pricing XML: Warranty plan pricing configurations

    • Inventory XML: Warranty product availability settings

  3. Technical Documentation

    • Detailed deployment instructions

    • Configuration parameters and settings

    • API integration specifications


Stuck during configuration? Check the FAQs Page for detailed solutions, contact your SureBright representative for immediate assistance, or email support@surebright.com for technical support.

Next: go to the Business Manager Setup. After that, schedule the Jobs, run the Testing Guide checks, then deploy to production and monitor.