Members - Register



Endpoint

POST /v1.1/member/register

Description

Accepts authentication credentials and associated user data to 'register' a member with AE. Returns information about newly created or existing member

Parameters
required *

apiKey *  string Your API access key
service *  string service identifier - email, twitter, facebook, google, instagram, lastfm, youtube, spotify, tumblr, soundcloud, foursquare, deezer
authtoken  string primary token returned by authorizing service. Required for social network registrations
uid  string unique id of user on the service in question eg. Spotify User ID, Twitter ID. Required for social network registrations.
authsecret  string authentication secret returned by some authorizing services. eg Twitter
firstname  string firstname from authorizing services if available
surname  string lastname authorizing services if available
username  string username from authorizing services if available
email  string email address from authorizing services. Required for email registration.
password  string Required for email registration.
birthdate  string date of birth from authorizing services if available (dd-mm-yyyy)
gender  string values: M, F, Other
city  string City of member
country  string Country of member in alpha-2 code. eg. US, CA, GB, etc
region  string Region with country for member. eg state or province
postcode  string Postal code of member
partner  string partner id (provided by Appreciation Engine support)
code  string import code (provided by Appreciation Engine support)
sourceuid  string external id used by partner
domain  string website to associate registration with
ip  string IP address to associate registration with
useragent  string The user agent string for the visiting user browser. Will identify device type for analytics.
segmentid  integer The ID of an existing segment to include the registering member in.
id  integer The ID of an existing user. Will attach new service to user or update existing service data. Use the endpoint format /member/[memberid]/register

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

Example Request

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

curl_setopt_array($curl, array( 
	CURLOPT_URL => "https://api.theappreciationengine.com/v1.1/member/register?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/register?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/register?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&service=twitter',
	'headers': {}
};
request(options, function (error, response) {
	if (error) throw new Error(error);
	console.log(response.body);
});

Example Response

{
"data": {
"ID": 1234,
"Email": "captjeanlucpicard@starfleet.com",
"FirstName": "Jean Luc",
"Surname": "Picard",
"Country": "",
"City": null,
"State": null,
"PostCode": null,
"Gender": "M",
"Username": "JLP",
"AccessToken": "0345481636hbjvhf2_1588732857",
"AvatarURL": "http://someurl.com",
"CountryCode": "",
"GeoCountry": null,
"VerifiedEmail": "captjeanlucpicard@starfleet.com"
},
"optins": [],
"services": [
{
"Service": "spotify",
"Valid": "1",
"ActivitySharing": "1",
"ID": "33333",
"UserID": "1111",
"Username": "JLP",
"UserURL": null,
"Token": "asdf",
"TokenSecret": "asdfasdf",
"LastUpdated": null,
"LastLogin": "2358-05-05 16:00:00",
"VerifiedEmail": "captjeanlucpicard@starfleet.com",
"PaidAccount": "0",
"Followers": "1",
"Likes": "0",
"PartnerCode": null,
"PartnerID": null,
"Domains": [
"API"
]
}
],
"jwt": "eyJhbGciOiJSUzI1NiIsInR5cCI6boT4UTTHJXbnE28MW5lUzuU5WwKaowaLyTdesQ"
}