Working API for subscribing and unsubscribing
This commit is contained in:
Andris Reinman
parent
d5222f7b4d
commit
11f412ded1
15 changed files with 439 additions and 24 deletions
|
|
@ -167,7 +167,7 @@
|
|||
<input type="hidden" name="_csrf" value="{{csrfToken}}">
|
||||
<input type="hidden" name="id" value="{{id}}" />
|
||||
|
||||
<button type="submit" class="btn btn-danger"><span class="glyphicon glyphicon-remove" aria-hidden="true"></span> Cancel</a>
|
||||
<button type="submit" class="btn btn-danger"><span class="glyphicon glyphicon-remove" aria-hidden="true"></span> Cancel
|
||||
</button>
|
||||
</form>
|
||||
</div>
|
||||
|
|
@ -178,7 +178,7 @@
|
|||
<input type="hidden" name="_csrf" value="{{csrfToken}}">
|
||||
<input type="hidden" name="id" value="{{id}}" />
|
||||
|
||||
<button type="submit" class="btn btn-info"><span class="glyphicon glyphicon-pause" aria-hidden="true"></span> Pause</a>
|
||||
<button type="submit" class="btn btn-info"><span class="glyphicon glyphicon-pause" aria-hidden="true"></span> Pause
|
||||
</button>
|
||||
</form>
|
||||
</div>
|
||||
|
|
@ -192,7 +192,7 @@
|
|||
<input type="hidden" name="_csrf" value="{{csrfToken}}">
|
||||
<input type="hidden" name="id" value="{{id}}" />
|
||||
|
||||
<button type="submit" class="btn btn-info"><span class="glyphicon glyphicon-play" aria-hidden="true"></span> Resume</a>
|
||||
<button type="submit" class="btn btn-info"><span class="glyphicon glyphicon-play" aria-hidden="true"></span> Resume
|
||||
</button>
|
||||
</form>
|
||||
</div>
|
||||
|
|
@ -211,10 +211,10 @@
|
|||
<input type="hidden" name="id" value="{{id}}" />
|
||||
</form>
|
||||
|
||||
<button type="submit" form="continue-sending" class="btn btn-info"><span class="glyphicon glyphicon-play" aria-hidden="true"></span> Continue</a>
|
||||
<button type="submit" form="continue-sending" class="btn btn-info"><span class="glyphicon glyphicon-play" aria-hidden="true"></span> Continue
|
||||
</button>
|
||||
|
||||
<button type="submit" form="reset-sending" class="btn btn-danger"><span class="glyphicon glyphicon-refresh" aria-hidden="true"></span> Reset</a>
|
||||
<button type="submit" form="reset-sending" class="btn btn-danger"><span class="glyphicon glyphicon-refresh" aria-hidden="true"></span> Reset
|
||||
</button>
|
||||
|
||||
</div>
|
||||
|
|
@ -236,7 +236,7 @@
|
|||
<input type="hidden" name="id" value="{{id}}" />
|
||||
</form>
|
||||
|
||||
<button type="submit" form="inactivate-sending" class="btn btn-warning"><span class="glyphicon glyphicon-pause" aria-hidden="true"></span> Pause</a>
|
||||
<button type="submit" form="inactivate-sending" class="btn btn-warning"><span class="glyphicon glyphicon-pause" aria-hidden="true"></span> Pause
|
||||
</button>
|
||||
</div>
|
||||
|
||||
|
|
@ -248,7 +248,7 @@
|
|||
<input type="hidden" name="id" value="{{id}}" />
|
||||
</form>
|
||||
|
||||
<button type="submit" form="activate-sending" class="btn btn-info"><span class="glyphicon glyphicon-play" aria-hidden="true"></span> Activate</a>
|
||||
<button type="submit" form="activate-sending" class="btn btn-info"><span class="glyphicon glyphicon-play" aria-hidden="true"></span> Activate
|
||||
</button>
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -72,6 +72,11 @@
|
|||
<span class="glyphicon glyphicon-cog" aria-hidden="true"></span> Settings
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/users/api">
|
||||
<span class="glyphicon glyphicon-retweet" aria-hidden="true"></span> API
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/users/logout">
|
||||
<span class="glyphicon glyphicon-log-out" aria-hidden="true"></span> Log out
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@
|
|||
<hr>
|
||||
|
||||
<div class="table-responsive">
|
||||
<table class="table table-bordered table-hover data-table display nowrap" width="100%" data-row-sort="0,1,1,0,0">
|
||||
<table class="table table-bordered table-hover data-table display nowrap" width="100%" data-row-sort="0,1,1,1,0,0">
|
||||
<thead>
|
||||
<th class="col-md-1">
|
||||
#
|
||||
|
|
@ -20,6 +20,9 @@
|
|||
<th>
|
||||
Name
|
||||
</th>
|
||||
<th class="col-md-2">
|
||||
ID
|
||||
</th>
|
||||
<th class="col-md-1">
|
||||
Subscribers
|
||||
</th>
|
||||
|
|
@ -44,6 +47,9 @@
|
|||
{{name}}
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
<input class="click-select gpg-text" type="text" readonly value="{{cid}}">
|
||||
</td>
|
||||
<td>
|
||||
<p class="text-center">{{subscribers}}</p>
|
||||
</td>
|
||||
|
|
|
|||
91
views/users/api.hbs
Normal file
91
views/users/api.hbs
Normal file
|
|
@ -0,0 +1,91 @@
|
|||
<ol class="breadcrumb">
|
||||
<li><a href="/">Home</a></li>
|
||||
<li class="active">API</li>
|
||||
</ol>
|
||||
|
||||
<h2>API</h2>
|
||||
|
||||
<hr>
|
||||
|
||||
<div class="panel panel-default">
|
||||
<div class="panel-body">
|
||||
<div class="pull-right">
|
||||
<form class="form-horizontal confirm-submit" {{#if accessToken}} data-confirm-message="Are you sure? Resetting would invalidate the currently existing token." {{else}} data-confirm-message="Are you sure?" {{/if}} method="post" action="/users/api/reset-token">
|
||||
<input type="hidden" name="_csrf" value="{{csrfToken}}">
|
||||
<button type="submit" class="btn btn-info"><span class="glyphicon glyphicon-retweet" aria-hidden="true"></span>
|
||||
{{#if accessToken}}
|
||||
Reset Access Token
|
||||
{{else}}
|
||||
Generate Access Token
|
||||
{{/if}}
|
||||
</button>
|
||||
</form>
|
||||
</div>
|
||||
{{#if accessToken}}
|
||||
Personal access token: <code>{{accessToken}}</code>
|
||||
{{else}}
|
||||
Access token not yet generated
|
||||
{{/if}}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3>POST /api/subscribe/:listId – Add subscription</h3>
|
||||
|
||||
<p>
|
||||
This API call either inserts a new subscription or updates existing. Fields not included are left as is, so if you update only LAST_NAME value, then FIRST_NAME is kept untouched for an existing subscription.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<strong>GET</strong> arguments
|
||||
</p>
|
||||
<ul>
|
||||
<li><strong>access_token</strong> – your personal access token
|
||||
</ul>
|
||||
|
||||
<p>
|
||||
<strong>POST</strong> arguments
|
||||
</p>
|
||||
<ul>
|
||||
<li><strong>EMAIL</strong> – subscriber's email address (<em>required</em>)
|
||||
<li><strong>FIRST_NAME</strong> – subscriber's first name
|
||||
<li><strong>LAST_NAME</strong> – subscriber's last name
|
||||
<li><strong>TIMEZONE</strong> – subscriber's timezone (eg. "Europe/Tallinn", "PST" or "UTC"). If not set defaults to "UTC"
|
||||
<li><strong>MERGE_TAG_VALUE</strong> – custom field value. Use yes/no for option group values (checkboxes, radios, drop downs)
|
||||
<li>
|
||||
<strong>FORCE_SUBSCRIBE</strong> – set to "yes" if you want to make sure the email is marked as subscribed even if it was previously marked as unsubscribed. By default if the email was already unsubscribed then subscription status is not changed.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>
|
||||
<strong>Example</strong>
|
||||
</p>
|
||||
|
||||
<pre>curl -XPOST {{serviceUrl}}api/subscribe/B16uVTdW?access_token={{accessToken}}\
|
||||
--data 'EMAIL=test@example.com&MERGE_CHECKBOX=yes'</pre>
|
||||
|
||||
<h3>POST /api/unsubscribe/:listId – Remove subscription</h3>
|
||||
|
||||
<p>
|
||||
This API call marks a subscription as unsubscribed
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<strong>GET</strong> arguments
|
||||
</p>
|
||||
<ul>
|
||||
<li><strong>access_token</strong> – your personal access token
|
||||
</ul>
|
||||
|
||||
<p>
|
||||
<strong>POST</strong> arguments
|
||||
</p>
|
||||
<ul>
|
||||
<li><strong>EMAIL</strong> – subscriber's email address (<em>required</em>)
|
||||
</ul>
|
||||
|
||||
<p>
|
||||
<strong>Example</strong>
|
||||
</p>
|
||||
|
||||
<pre>curl -XPOST {{serviceUrl}}api/unsubscribe/B16uVTdW?access_token={{accessToken}}\
|
||||
--data 'EMAIL=test@example.com'</pre>
|
||||
Loading…
Add table
Add a link
Reference in a new issue