API Documentation

DandyID's API gives developers the ability to create better social networks by allowing users to more clearly define who they are, helping them to connect with one another on a more personal level, and making it easier for new users to get up and running more quickly. User experience is important, and users on DandyID-enabled sites form tighter bonds with each other and connect in more meaningful ways. DandyID tools can help you turn casual visitors into die-hard fans.

Getting started with the DandyID API is easy. First apply for an API key, then check out our API documentation below. Also, visit Extend & Share to see some of the apps built on our API. If you have any quesions, or would like to become a trusted partner, please contact us.

PROFILE:
No one wants to fill out the same form over and over. Save your users time and reduce headaches by leveraging the return_profile API call to access a user's globally recognizable profile.

IDENTITIES:
The return_services and reverse_lookup API calls lets you discover where your users exist on over 250 sites. Use that information to understand them better, connect with them in more meaningful ways and tap into their other online activities.

CONTACTS:
(coming soon) A social network is nothing without friends. The return_contacts API call make it easy for your users to connect with their existing contacts on your service.

Portable Contacts:
DandyID also supports Portable Contacts -- an open standard that combines some of the functionality of the API calls listed above.
Pro Accounts:
Additional data and API calls are available for our partners, please contact us if you are interested.

return_profile

Returns xml formatted information about the user.

This call is useful if your site has user profile pages and you don't want to store that data, or you want the data pre-populated for the user when they enter their profile.

Note: Unless you are trying to retrieve data that you have pushed into DandyID or that was created as a result of first calling sync_user, then set the optional profile_type parameter to "public"

Request URL: GET

http://www.dandyId.org/api/return_profile/{api_key}/{user_identifier}

GET Request parameters

Parameter	Type	Description
api_key	string (required)	Your api key
user_identifier	string (required)	Can be either an MD5 hashed email address or DandyID user id

Values Returned as XML

Parameter

Type

Description

prefixName

string

Appropriate name prefix for user (Mr, Ms, Mrs, Dr etc...)

firstName

string

The first name of the user.

middleName

string

The middle name of the user.

lastName

string

The users family name.

suffixName

string

Appropriate name suffix for user, if applicable. (Jr, Sr, Esq, etc..)

nickName

string

The user's nickname if it was entered.

userGender

string

The user's gender. Possible values are 'male','female', or 'transgender'

userBirthday

string

The user's birthday. Format is YYYY-MM-DD.

emailAddress

string

The user's email address.

userMessaging

XML node

container node element for userScreenName elements

userScreenName

XML node

Parameter	Type	Description
service	string	Instant Messaging Service, ('aim','gtalk','yahoo','msn',icq','jabber')
screenname	string	The user's screenname for the service listed.

userTelephones

XML node

Container node for telephone elements.

telephone

XML node

Parameter	Type	Description
number	string	Telephone number for the user, formatted as it was inputted.
type	string	The type descriptor for the phone number. ('mobile', 'home' or 'office')

userWebsites

XML node

Container node for website elements.

website

XML node

Parameter	Type	Description
title	string	A title or short description given to the url.
address	string	A user entered url.

userAddress

XML Node

Parameter	Type	Description
streetAddress	string	The street and number of the user's address.
cityAddress	string	The city of the user's address.
regionAddress	string	The state or region of the user's address.
country	string	The country of the user's address.

userBio

string

A short description of the user.

Sample Response

The following is a sample response:

<?xml version="1.0" encoding="iso-8859-1"?>
			<userProfile>
			  <prefixName>Mr</prefixName>
			  <firstName>John</firstName>
			  <middleName>Edward</middleName>
			  <lastName>Doe</lastName>
			  <suffixName>Esq</suffixName>
			  <nickName>Johnny</nickName>
			  <userGender>male</userGender>
			  <userBirthday>1974-01-10</userBirthday>
			  <emailAddress>johndoe@dandyid.org</emailAddress>
			  <userMessaging>
			    	<userScreenName>
			      		<service>aim</service>
			      		<screenname>dandyid</screenname>
			    	</userScreenName>
			  </userMessaging>
			  <userTelephones>
			    	<telephone>
			      		<number>(401) 555-5555</number>
			      		<type>mobile</type>
			    	</telephone>
			  </userTelephones>
			  <userWebsites>
			    	<webSite>
			      		<title>Blog</title>
			      		<address>http://blog.dandyid.org/</address>
			    	</webSite>
			  </userWebsites>
			  <userAddress>
			    	<streetAddress>118 N Main St.</streetAddress>
			    	<cityAddress>Providence</cityAddress>
			    	<regionAddress>RI</regionAddress>
			    	<country>US</country>
			  </userAddress>
			  <userBio>My Name is John Doe. This is my Bio.</userBio>
			</userProfile>

API Documentation

Getting started with the DandyID API is easy. First apply for an API key, then check out our API documentation below. Also, visit Extend & Share to see some of the apps built on our API. If you have any quesions, or would like to become a trusted partner, please contact us.

PROFILE:

IDENTITIES:

CONTACTS:

Portable Contacts:

Pro Accounts:

return_profile

Returns xml formatted information about the user.

Request URL: GET

http://www.dandyId.org/api/return_profile/{api_key}/{user_identifier}

GET Request parameters

Values Returned as XML

Sample Response

The following is a sample response: