Skip to content
This repository has been archived by the owner on Feb 12, 2022. It is now read-only.

Latest commit

 

History

History
110 lines (80 loc) · 4.33 KB

README.md

File metadata and controls

110 lines (80 loc) · 4.33 KB
Raw

#SubscriberSearch-nod(e)

Subscriber Search is a sample application illustrating how to create a Hub Exchange app utilizing Single Sign-on (SSO) for ExactTarget's Interactive Marketing Hub.

This sample app provides you assets and examples demonstrating the basics on "how-to" create a user-contextualized Subscriber Search app which implement ExactTarget's Fuel Platform suite of tools.

Prior to working with these examples, you should feel confident using App Center. App Center is the your primary interface to register as a developer with ExactTarget and the tool you use to define apps which will integrate with the Fuel Platform.

The source code for these sample applications are open sourced and the code provided is intended to quickly enable you with the core concepts of developing apps with ExactTarget.

The Subscriber Search app you'll be building offers beneficial functionality; however the Sample Apps should be considered proof of concept style coding and there may additional security / performance steps that are outside the scope of it's purpose.

Subscriber Search Sample App

##Prerequisites (basic understanding of the following):

  • (x)HTML(5)
  • CSS(3)
  • JavaScript
  • AJAX, REST and RESTful interactions
  • SOAP
  • Backbone.js (client-side JS MVC tool)
  • Underscore.js (Backbone's only dependency)
  • jQuery
  • Node.js installed locally

Nice-to-haves

  • Volo installed locally

##Running Sample Apps Nearly every sample application we provide will require your API Keys (clientId, clientSecret) and the proper understanding of how to use these assets, please make sure you take time to review our App Center tutorial.

##Requirements

##Quick start

  • Clone the repo onto your local computer.

      - (http): https://github.com/ExactTarget/SubscriberSearch-nod.git
  - (ssh): [email protected]:ExactTarget/SubscriberSearch-nod.git

  • Create a new Hub Exchange application in App Center

App Type

	Hub Exchange (Alpha)

Meta Data

	Name		: Subscriber Search
	Descrip.	: [your choice]
	Namespace	: [your choice] (I typically use: Example: bdean-subscribersearch [first initial last name-appname)

Integration

	Select the stack where your ExactTarget account resides

Application Paths

    Login URL   : http://localhost:3000/login
    Home URL    : http://localhost:3000
    Logout URL  : http://localhost:3000/logout

  • Publish your app in app center (this makes it available in the HUB

  • Update the app-config.js file with the following app information (values for these come from App Center):

      Client ID
  Client Secret
  App Signature

  • Commit your changes

  • Start your app locally by running the command: node app

  • Login to the Interactive Marketing Hub and then click your app

Touchpoints

  • App Center utilization
    • Creating an app in App Center
    • Defining our app's endpoints
    • Application Keys / Signature definitions
  • Subscriber Search App build up
    • Server-side
      • Login URL
      • Redirect URL
      • Logout URL
      • Implementing the JWT (JSON Web Token)
    • Client-side
      • Fuel UX implementation
      • Fuel Platform API implementation
      • ExactTarget SOAP API implementation

Copyright and license

Copyright (c) 2012 ExactTarget

Licensed under the MIT License (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the COPYING file.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

For more information about setting up an applcation in App Center, please see http://code.exacttarget.com/devcenter/getting-started/app-center-overview/