• API 
    •  API Endpoints
    •  Developer Guides 
  • Dashboard 
  • Login
  • Sign Up
  • Switch to API v1.0
  • Account

    • Account Usage

      Hits per account/application, per time period

  • Activities

    • Activities

      Return a list of all of your activities

    • Activities Count Daily - [advanced]

      Returns a list of collated daily activity counts.

    • Activities Count Services - [advanced]

      Return a daily activity count breakdown by service

    • Create

      Create a tracking activity

    • Delete - [advanced]

      Delete an existing activity

    • Edit - [advanced]

      Edit an existing tracking activity

    • Feed

      Activity data feed

    • Record - [advanced]

      Manually record an activity for your data feed

    • Segment Presave - [advanced]

      Adds a Spotify track or album to the library of all opted in members of a segment

  • Applications

    • Application Information

      Return all social sign in and registration urls for a particular api key

    • App Unwhitelist - [advanced]

      Remove domain from application whitelist in order to disable AE Connect JS Framework

    • App Whitelist - [advanced]

      Add domain to application whitelist in order to enable AE Connect JS Framework

  • Brands

    • Show

      Return a specific brand's details

    • Activities

      Return a list of all of your activities.

    • Create - [advanced]

      Create a new brand

    • Crossover

      Return associated brand details

    • Delete - [advanced]

      Delete an existing brand

    • Edit - [advanced]

      Update an existing brand

    • Segments

      Return a list of all of your segments

    • Activity Breakdown Totals

      Obtain a tally of the top activities in your network

    • Age Breakdown

      Get a breakdown of the ages of your users

    • Gender Breakdown

      Get a breakdown of the genders of your users

    • Location Breakdown

      Obtain a breakdown member activity by location with activity count for each country

    • Active Members Breakdown

    • Segment Stats

      Obtain an all-time overall total of members and activities for the segment

    • Activity Breakdown Timeline

      Obtain a breakdown of activity totals by day grouped by service type

    • Show All

      Return a list of all of the brands being monitored by your Appreciation Engine account

    • Optin Brand

      Opt a member into a brand's list

    • Optout Brand

      Opt a memberout of brand's list.

  • Login Statistics

    • Members Registration Totals All-Time

      Get a list of all-time member registration totals broken down by domain, service or country

    • Members Registration Channels

      Returns a list of channels members have registered with and a count of registrations per channel.

    • Members Registration Domains

      Returns a list of the domains members have registered on, broken down by registrations per channel.

    • Members Registration Timeline

      Obtain a registration/sign-up timeline grouped by the service used to sign up

    • Members Registration Totals

      Get a list of member registration totals broken down by domain, service or country

  • Members

    • Check Member Activity

      Returns a state of true or false, as well as information for a completed action on a social network for a specified user.

    • Show

      Returns member profile data

    • Delete Member Activity

      Delete specified activity for member

    • Delete

      Remove a member

    • Login Domains

    • Top Domains

    • Login

      Login existing member

    • Refresh Tokens - [advanced]

      Refresh a user's tokens for a specific service

    • Register

      Register a member authentication

    • Register Member Service

      Register a member service

    • Reset - [advanced]

      Update a member's password

    • Update

      Updates member data

    • Verify

      Manually verify an email address for a user

    • Active

      Returns members and associated profile data, sorted by most active within time range specified (default 1 week)

    • Members Activity Totals

      Return a registration / sign-up breakdown / totals for an application, domain, or service over a timeline (eg. daily)

    • All

      Returns members and associated profile data

    • Extended

      Returns members, and associated profile data, based on criteria specified by parameters, ordered by the extended node.

    • Login

      Returns members, and associated profile data, ordered by last login.

    • Member Visit Totals

      Return a visit and conversion total for an application, domain, or service over a timeline (eg. daily)

    • Opt In

      Opt a member into your global list.

    • Opt Out

      Opt a member out of your global list

  • Miscellaneous

    • Auth

      Verify authentication via the Appreciation Engine

  • Segments

    • Optin Segments

      Opt a member into your segment list.

    • Optout Segments

      Opt a member out of your segment list.

    • Segments

      Return a list of all of your segments

    • Create - [advanced]

      Create a new segment

    • Delete - [advanced]

      Delete an existing segment

    • Edit - [advanced]

      Update an existing segment


Members - Login



Endpoint

POST /v1.1/member/login

Description

Accepts authentication credentials to login an existing member. Logs login event and returns information about the existing member.

Parameters
required *

apiKey *  string Your API access key
service *  string service identifier - email, twitter, facebook, google, instagram, lastfm, rdio, youtube, spotify, tumblr, beatsmusic, soundcloud, foursquare, deezer
authtoken  string primary token returned by authorizing service. Required for social network registrations
uid  string unique id of user. Required for social network registrations.
authsecret  string authentication secret returned by some authorizing services. eg Twitter
email  string email address from authorizing services. Required for email login.
password  string Required for email login.
domain  string website to associate registration with
ip  string IP address to associate registration with
strict_sso  integer A value of 1 means member must have registered previously on specified domain. Otherwise a previous registration anywhere using current AE Application is valid (SSO)

Sign in with your developer account to use the console, or sign up here

Example Request

  • cURL
  • PHP
  • Python
  • NodeJS
curl -X POST "https://api.theappreciationengine.com/v1.1/member/login?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&service=twitter"
$curl = curl_init();

curl_setopt_array($curl, array( 
	CURLOPT_URL => "https://api.theappreciationengine.com/v1.1/member/login?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&service=twitter", 
	CURLOPT_RETURNTRANSFER => true, 
	CURLOPT_ENCODING => "", 
	CURLOPT_MAXREDIRS => 10, 
	CURLOPT_TIMEOUT => 0, 
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, 
	CURLOPT_CUSTOMREQUEST => "POST", 
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
import requests

url = "https://api.theappreciationengine.com/v1.1/member/login?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&service=twitter"

headers = {}
payload = {}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text.encode('utf8'))
var request = require('request');
var options = {
	'method': 'POST',
	'url': 'https://api.theappreciationengine.com/v1.1/member/login?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&service=twitter',
	'headers': {}
};
request(options, function (error, response) {
	if (error) throw new Error(error);
	console.log(response.body);
});

Example Response

{
"data": {
"FirstName": "Jean Luc",
"Surname": "Picard",
"Email": "captjeanlucpicard@starfleet.com",
"Username": "JLP",
"Gender": "M",
"Bio": "Tea, Earl Grey, Hot.",
"AccessToken": "0e2feea5d863",
"ID": 1111,
"AvatarURL": "http://someurl.com",
"Country": null,
"City": null,
"State": null,
"CountryCode": null,
"GeoCountry": null,
"GeoCity": null,
"GeoRegion": null,
"GeoLat": null,
"GeoLong": null,
"VerifiedEmail": "captjeanlucpicard@starfleet.com"
},
"optins": [
{
"ID": "1111",
"Type": "Brand",
"SegmentID": null,
"Label": null,
"Name": "Starfleet"
},
{
"ID": "1701",
"Type": "3333",
"SegmentID": "Segment",
"Label": null,
"Name": "Launching the new Enterprise"
}
],
"services": [
{
"Service": "email",
"Valid": "1",
"ActivitySharing": "1",
"ID": "2222",
"UserID": "b8c44c025b",
"Username": "captjeanlucpicard@starfleet.com",
"UserURL": null,
"Token": "$2y$10$a42da5662OqqyyGEl4.",
"TokenSecret": "1033c28a4e",
"LastUpdated": null,
"LastLogin": "2363-05-07 15:00:00",
"VerifiedEmail": "captjeanlucpicard@starfleet.com",
"PaidAccount": "0",
"Followers": "0",
"Likes": "0",
"PartnerCode": null,
"PartnerID": null,
"Domains": [
"API"
]
},
{
"Service": "twitter",
"Valid": "1",
"ActivitySharing": "1",
"ID": "4444",
"UserID": "3456",
"Username": "jlp",
"UserURL": "http://twitter.com/jeanlucpicard",
"Token": "thisisatokenofmyappreciation",
"TokenSecret": "itsasecret",
"LastUpdated": "2363-05-07 15:00:00",
"LastLogin": "2363-05-07 15:00:00",
"VerifiedEmail": "captjeanlucpicard@starfleet.com",
"PaidAccount": "0",
"Followers": "0",
"Likes": "0",
"PartnerCode": null,
"PartnerID": null,
"Domains": [
"API"
]
}
],
"jwt": "eyJhbGciOiJSUzI1NiIsInRnwjrAxvDvg1Cas8m5XOz80zz9n0l5CxrHsSljw477_3-rtOlQLkuLGjKCPRsmZJvNIz-02h9_EbCkVDr1zOGNNR1vBu3l4-SWaEbqWeBVs"
}

© Copyright Appreciation Engine Inc 2021, all rights reserved. See our Terms & Conditions, Privacy Policy, Cookie Policy and Privacy Promise.

We are grateful to the lək̓ʷəŋən People of the Esquimalt and Songhees Nations on whose traditional territories Appreciation Engine is based. We also wish to give thanks to the W̱SÁNEĆ, Hul’q’umi’num’, and Snuneymuwx Peoples of the Coast Salish First Nations, and the Ngāti Toa, Muaūpoko, and Ngāti Raukawa ki te Tonga of the Māori iwi, on whose traditional territories the team members of AE work and live.