Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/workarea-commerce/workarea-emarsys


https://github.com/workarea-commerce/workarea-emarsys

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

Workarea Emarsys
================================================================================

Emarsys plugin for the Workarea platform.

This integration supports the following:

1. Contact syncronization
2. Product files
3. Order syncronization
4. Full Web-Extend Analytics integration

The Workarea Emarsys integration is a Emarsys Add-on. Contact your Emarsys support person to
have the Workarea Emarsys integration enabled for your account.

Getting Started
--------------------------------------------------------------------------------

Add the gem to your application's Gemfile:

```ruby
# ...
gem 'workarea-emarsys'
# ...
```

Update your application's bundle.

```bash
cd path/to/application
bundle
```

Configuration
--------------------------------------------------------------------------------
The following fields can be edited via the admin site settings:

1. **Production:** A toggle switch to set the integration into production mode, defaults to true.
2. **Merchant ID:** The merchant ID of the Emarsys account. This value is required for the Web Extend Analytics Integration

The contact and sales data APIs require different access keys that require storage in the secrets file. You can generate a user for the contact API in the Emarsys admin.

Add the following to your secrets:

emarsys:
user_name: YOUR_API_USER_NAME_HERE
secret_key: YOUR_API_SECRET_KEY_HERE
emarsys_sales:
api_token: YOUR_TOKEN_HERE

Data Exporting
--------------------------------------------------------------------------------
**Product Data**

Emarsys supports the google product feed specification for product catalog. This integration includes the Workarea Google Product feed to support exporting products. The Google product feed will generate at 5:00 AM daily.

You can access the Google product feed at: https://www.your_domain.com/google_feed

**Order Files**

Order files are exported every six hours. The default order fields are supported.

More information about order files can be found here: https://help.emarsys.com/hc/en-us/articles/360003070654-Preparing-your-sales-data-file

Workarea Commerce Documentation
--------------------------------------------------------------------------------

See [https://developer.workarea.com](https://developer.workarea.com) for Workarea Commerce documentation.

License
--------------------------------------------------------------------------------

Workarea Emarsys is released under the [Business Software License](LICENSE)