Boomtrain Support boomtrain-support

boomtrain-support / get-notifications-id-response.js

Created August 31, 2015 16:53

GET /notifications/:id - Retrieve details about a single Campaign.

	{
	active: {true or false},
	app: "{app_id}",
	emailData: {
	from: '{The From: Address Information}',
	layout: '{A JSON array with the body of the email}',
	subject: '{The Subject of the email}'
	},
	exclude: {
	resources: '{A JSON array of resources to exclude from Recommendation Blocks}'

boomtrain-support / get-notifications-id-jquery.html

Created August 31, 2015 16:54

GET /notifications/:id - An example request for this endpoint using jQuery

	<script>
	// Get the details about a Campaign
	function getNotificationId() {
	// Send a jQuery AJAX request to get the Campaign details
	$.ajax({
	url: 'https://api.boomtrain.com/notificaions/{id}',
	// Replace your Username, Password, and App Id
	headers: {
	'x-app-id': '{app_id}',
	'Content-Type': 'application/json',

boomtrain-support / get-notifications-id-curl

Created August 31, 2015 16:55

GET /notifications/:id - An example request for this endpoint using cURL

	curl -u {username}:{password}
	-H 'x-app-id: {app_id}'
	-X GET
	'https://api.boomtrain.com/notifications/{id}'

boomtrain-support / authentication-oauth-jquery.html

Last active August 31, 2015 17:20

API Authentication - An example authentication request using jQuery

	<script>
	// Use the OAuth Token with another request
	function useToken() {
	//Send a jQuery AJAX request
	$.ajax({
	url: 'https://api.boomtrain.com/{endpoint}',
	// Replace with your Username and App Id,
	// using the OAuth Token in place of your Password
	headers: {
	'x-app-id': '{app_id}',

boomtrain-support / authentication-oauth-curl

Last active August 31, 2015 17:02

API Authentication - An example OAuth token authentication request using cURL

	curl -u {username}:{OAuth Token}
	-H 'x-app-id: {app_id}'
	-X {HTTP Method}
	'https://api.boomtrain.com/{endpoint}'

boomtrain-support / authentication-jquery-example.js

Created August 31, 2015 17:05

API Authentication - An example of basic authentication using jQuery

	$.ajax({
	url: 'https://api.boomtrain.com/{endpoint}',
	headers: {
	'x-app-id': '{app_id}',
	'Authentication': 'Basic ' + btoa('{username}:{password}')
	},
	...
	});

boomtrain-support / authentication-curl-example

Created August 31, 2015 17:06

API Authentication - An example of basic authentication using cURL

	curl -u {username}:{password}
	-H 'x-app-id: {app_id}'
	-X {HTTP Method}
	'https://api.boomtrain.com/{endpoint}'

boomtrain-support / authentication-request-token-curl

Created August 31, 2015 17:08

API Authentication - An example requesting an OAuth token using cURL

	curl -u {username}:{password}
	-H 'x-app-id: {app_id}'
	-X {HTTP Method}
	'https://api.boomtrain.com/tokens'

boomtrain-support / authentication-request-token-jquery.js

Created August 31, 2015 17:11

API Authentication - An example to request an OAuth token using jQuery

	$.ajax({
	url: 'https://api.boomtrain.com/tokens',
	headers: {
	'x-app-id': '{app_id}',
	'Authentication': 'Basic ' + btoa('{username}:{password}')
	},
	...
	});

boomtrain-support / apiHeader-curl-example

Created August 31, 2015 17:14

API Header - An example header when using cURL

	curl
	-H 'x-app-id: {app_id}'
	'https://api.boomtrain.com/{endpoint}'