Generated gh-pages for commit 30e5b56

Author: Tanya Romas <[email protected]>

    [PR-22981] [Documentation] Clarify params encryption logic (#342)

_sources/advanced_features/params_encryption.rst.txt

@@ -15,7 +15,7 @@ So, instead of sending params in plain text, you can send them encrypted.
 Site public encryption key
 --------------------------
 
-To get your unique site public encryption key, go to **All Site Settings → Integrations → API integration → Public encryption key for email addresses**.
+To get your unique site public encryption key, go to **All Site Settings → Integrations → JS integration → Public encryption key**.
 
 Passing email as a GET parameter to Standalone Campaign
 -------------------------------------------------------
@@ -160,6 +160,11 @@ Node.js Example
 Front-end Part
 --------------
 
+.. important::
+   Do not use params encryption for :ref:`Talkable backend API <api_v2/origins>`.
+
+   Params encryption is only for JS integration.
+
 Please modify the front-end using this pseudo code example:
 
 .. code-block:: html

advanced_features/converting_into_localization.html

@@ -262,10 +262,8 @@ <h2>Custom Option (Configuration) Localization<a class="headerlink" href="#custo
 <p>In addition to localizing Images, Colors, and static copy Talkable allows you to build really advanced Localizations where you can AB test or switch between different visual layouts of campaign Views.</p>
 <p>An example can be to create an AB test for Equal Emphasis (all 3 sharing channels look visually equal) vs. Email Emphasis where email sharing form stands out:</p>
 <blockquote>
-<div><a class="reference internal image-reference" href="../_images/share_page_equal_emphasis.png"><img alt="../_images/share_page_equal_emphasis.png" src="../_images/share_page_equal_emphasis.png" style="height: 250px;" />
-</a>
-<a class="reference internal image-reference" href="../_images/share_page_email_emphasis.png"><img alt="../_images/share_page_email_emphasis.png" src="../_images/share_page_email_emphasis.png" style="height: 250px;" />
-</a>
+<div><a class="reference internal image-reference" href="../_images/share_page_equal_emphasis.png"><img alt="../_images/share_page_equal_emphasis.png" src="../_images/share_page_equal_emphasis.png" style="height: 250px;" /></a>
+<a class="reference internal image-reference" href="../_images/share_page_email_emphasis.png"><img alt="../_images/share_page_email_emphasis.png" src="../_images/share_page_email_emphasis.png" style="height: 250px;" /></a>
 </div></blockquote>
 <p>In order to chieve this AB test we need to</p>
 <blockquote>

advanced_features/customer_service_portal/use_case_5.html

@@ -122,12 +122,10 @@ <h1>Use case #5: <br> Blocklisting a user<a class="headerlink" href="#use-case-5
 if you discover that a user is posting links to a discounting coupon site or posting without your permission
 on social media pages.</p>
 <p>To blocklist a user, first navigate to the “Blocklist” section of the Customer Service Portal:</p>
-<a class="reference internal image-reference" href="../../_images/blocklist.png"><img alt="../../_images/blocklist.png" src="../../_images/blocklist.png" style="width: 644px;" />
-</a>
+<a class="reference internal image-reference" href="../../_images/blocklist.png"><img alt="../../_images/blocklist.png" src="../../_images/blocklist.png" style="width: 644px;" /></a>
 <section id="adding-a-user-to-the-blocklist">
 <h2>Adding a user to the blocklist<a class="headerlink" href="#adding-a-user-to-the-blocklist" title="Link to this heading">¶</a></h2>
-<a class="reference internal image-reference" href="../../_images/adding_blocklist.png"><img alt="../../_images/adding_blocklist.png" src="../../_images/adding_blocklist.png" style="width: 436px;" />
-</a>
+<a class="reference internal image-reference" href="../../_images/adding_blocklist.png"><img alt="../../_images/adding_blocklist.png" src="../../_images/adding_blocklist.png" style="width: 436px;" /></a>
 <p>(We support adding users to a blocklist using two methods, by Email or by IP address. To add an email to the
 blocklist, just enter the email into the “Blocked emails” field and press “Save Changes”. Note that emails are
 not separated by comma, but are new line delimited.)</p>

advanced_features/multi_currency.html

@@ -211,8 +211,7 @@ <h2>Currencies in reports<a class="headerlink" href="#currencies-in-reports" tit
 <li><p>filter by the currency of the purchase/event</p></li>
 <li><p>select a currency to convert the amounts to</p></li>
 </ul>
-<a class="reference internal image-reference" href="../_images/multi_currency_mar.png"><img alt="../_images/multi_currency_mar.png" src="../_images/multi_currency_mar.png" style="width: 300px;" />
-</a>
+<a class="reference internal image-reference" href="../_images/multi_currency_mar.png"><img alt="../_images/multi_currency_mar.png" src="../_images/multi_currency_mar.png" style="width: 300px;" /></a>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>If a currency to convert to is not specified, the site currency is used for conversion.</p>

advanced_features/params_encryption.html

@@ -123,7 +123,7 @@ <h1>Params Encryption<a class="headerlink" href="#params-encryption" title="Link
 So, instead of sending params in plain text, you can send them encrypted.</p>
 <section id="site-public-encryption-key">
 <h2>Site public encryption key<a class="headerlink" href="#site-public-encryption-key" title="Link to this heading">¶</a></h2>
-<p>To get your unique site public encryption key, go to <strong>All Site Settings → Integrations → API integration → Public encryption key for email addresses</strong>.</p>
+<p>To get your unique site public encryption key, go to <strong>All Site Settings → Integrations → JS integration → Public encryption key</strong>.</p>
 </section>
 <section id="passing-email-as-a-get-parameter-to-standalone-campaign">
 <h2>Passing email as a GET parameter to Standalone Campaign<a class="headerlink" href="#passing-email-as-a-get-parameter-to-standalone-campaign" title="Link to this heading">¶</a></h2>
@@ -262,6 +262,11 @@ <h2>Node.js Example<a class="headerlink" href="#node-js-example" title="Link to
 </section>
 <section id="front-end-part">
 <h2>Front-end Part<a class="headerlink" href="#front-end-part" title="Link to this heading">¶</a></h2>
+<div class="admonition important">
+<p class="admonition-title">Important</p>
+<p>Do not use params encryption for <a class="reference internal" href="../api_v2/origins.html#api-v2-origins"><span class="std std-ref">Talkable backend API</span></a>.</p>
+<p>Params encryption is only for JS integration.</p>
+</div>
 <p>Please modify the front-end using this pseudo code example:</p>
 <div class="highlight-html notranslate"><div class="highlight"><pre><span></span><span class="p">&lt;</span><span class="nt">script</span><span class="p">&gt;</span>
 <span class="w">  </span><span class="nx">_talkableq</span><span class="p">.</span><span class="nx">push</span><span class="p">([</span><span class="s1">&#39;authenticate_customer&#39;</span><span class="p">,</span><span class="w"> </span><span class="p">{</span>

advanced_features/tremendous.html

@@ -124,8 +124,7 @@ <h1>Tremendous Integration<a class="headerlink" href="#tremendous-integration" t
 <li><p>A referral campaign in Talkable having the following attributes:</p>
 <ul>
 <li><p>An Advocate Referral Incentive with “Tremendous” reward type</p>
-<a class="reference internal image-reference" href="../_images/tremendous_incentive.png"><img alt="Creating a Tremendous Advocate Referral incentive" src="../_images/tremendous_incentive.png" style="width: 400px;" />
-</a>
+<a class="reference internal image-reference" href="../_images/tremendous_incentive.png"><img alt="Creating a Tremendous Advocate Referral incentive" src="../_images/tremendous_incentive.png" style="width: 400px;" /></a>
 </li>
 <li><p>A <a class="reference internal" href="../campaigns/editor/filters.html#tremendous-filter"><span class="std std-ref">“tremendous” Liquid filter</span></a> used in Reward Paid Email Page.
 The filter generates a claim link within the specified Tremendous campaign.</p>

api_v2/intro.html

@@ -105,8 +105,7 @@ <h2>Access the Talkable API<a class="headerlink" href="#access-the-talkable-api"
 <p>Enter the <a class="reference internal" href="#authentication">API key</a> and click <strong>Authorize</strong> again:</p>
 <img alt="Authorize step 2" class="is-minimal" src="../_images/authorize2.png" />
 <p>Click <strong>Close</strong>. The Authorize lock icon changes to locked:</p>
-<a class="is-minimal reference internal image-reference" href="../_images/authorize3.png"><img alt="Authorize step 3" class="is-minimal" src="../_images/authorize3.png" style="width: 156px;" />
-</a>
+<a class="is-minimal reference internal image-reference" href="../_images/authorize3.png"><img alt="Authorize step 3" class="is-minimal" src="../_images/authorize3.png" style="width: 156px;" /></a>
 <h4>Actions</h4><p>For details about the API call, expand the API method for each call. To issue an
 API call from the Talkable API user interface, click <strong>Try it out</strong> for any
 method. Edit the Example Values in the request body and click <strong>Execute</strong>.</p>