Set Up Spree Integration

Before you start #

Review the following information before you connect Spree to Gladly.

• This is a multi-step integration where you’ll need to configure a Spree extension first before setting up Gladly. There are some technical requirements to complete this process, so we recommend working with a developer.
• If you need help configuring the Spree extension, we recommend working with Spree’s technology partner Upside. You can contact them at [email protected].
• You’ll need to create a separate Gladly user with an Administrator and API User role.

Create a Gladly user #

You must first create a Gladly user account with at least an API User role. This account will own the API token you need to set up the Spree extension.

1. See Generate API tokens for information on how to add users and how to generate an API token. Take note of the token as soon as it’s generated as it’s only shown once!
   • Note – You must have an Administrator role in Gladly to add users.
2. Once created, log into Gladly using the new account you created to make sure it’s working.

Once your Gladly user is created, proceed to set up the Spree extension.

Set up Spree extension #

We suggest working with a developer to configure the Spree extension. If additional assistance is needed, we recommend working with Spree’s technology partner, Upside. You can contact them at [email protected].

See the Spree Installation documentation for instructions on how to set up the extension.

Once Spree is configured, proceed to connect Spree to Gladly.

Connect Spree to Gladly #

The next step is to connect Gladly to SpreeCommerce. From the Apps page, click Add App > Custom.

1. From the Add New Custom App page, enter the following information:
   • Name – Enter a name that will help you identify the integration. We recommend using “Spree.”
   • URL – Enter the URL of your Lookup Adaptor. It would look something like https://<your-spree-url>/api/v1/customers/lookup.
     • You must use an “HTTPS” protocol.
   • Username – Enter the email address of the account you created in Gladly.
   • Password – Enter the API token you generated in Gladly.
   • Realm (Optional) – Leave this field blank.
   • Signing Key – Enter the key used to sign each request Gladly makes to your lookup service. Details about the Signing are found here .
   • Search Query Attributes – These are attributes that can be used to search for a Customer. There are two columns (Attribute, Label) required for Search Query Attributes. The email/Email, phone/Phone (only registered), and name/Name (only registered)attributes can be used in combination or by picking a subset.
     • Don’t change the Attribute column, but you can customize Label.
     • Searching by name and phone number works only for verified Customers only, and not guests.
   • Search Results Attributes – These attributes appear when linking a Customer to an external system like Spree. There are two columns (Attribute, Label) required for Search Results Attributes. The name/Name, email/Email, spreeID/Spree ID, and phone/Phone Number are attributes we recommended you use.
     • Don’t change the Attribute column, but you can customize Label.
   • Auto-Linking Fields – If a Customer Profile is not currently linked to a Spree instance, and if your Spree instance responds with a unique profile with at least one auto-linking field match and no conflicts, Gladly will automatically link the profiles without any user intervention and populate the pulled information in the Customer Profile.
     • Check the box next to Customer Email. Auto-linking by phone/Phone Number attribute is currently not supported.
   • Overwrite Existing Values – This must be activated for the integration to work. If a Customer Profile is linked to a profile in Spree, Gladly will overwrite the existing name, address, and editable custom attributes in the Customer Profile with data from Spree.
   • Enable Actions – Do not check this box.
2. Click Save App when you’re done. An error will appear if the required fields are not completed; they are highlighted in red. Complete the missing fields and click Save App again.