Raveal API

Authentication

The REST API requires user authentication to access or publish data. For instance, functionality on Raveal.com available to logged in users, such as checking profile visitor activity or retrieving profile data, are protected through the API. Currently, only HTTP Basic Authentication over HTTPS is supported. Basic Authentication sends user credentials in the header of the HTTP request.

In order to make an API call, the username and password of a Raveal account holder must be included with the request. Additionally, the request must be made to the secure HTTPS://raveal.net. Requests to http will be redirected.

Profile Summary

Returns summary info about the authenticated user's profile.

URL: [GET] https://raveal.net/api/profile.xml

Required Parameters
  • none

Returns JSON:

{ "id": "1", "title": "Title", "subtitle": "Sub Title", "public": "true", "email": "alternate@domain.com", "phone": "248-555-1212", "url": "myurl", "expertise": "Software", "secondaryExpertise1": "Web Development", "secondaryExpertise2": "Search", "professionalLevel": "Senior/Director", "fullTime": "true", "partTime": "true", "relocate": "true", "location": "Troy, MI", "zipCode": "48084", "yearsExperience": "10", "education": "Bachelor's Degree", "hasPortfolio": "true", "hasResume": "true", "hasVoice": "false", "bio": "This is my bio.", "featuredFile1": "/p/files/1/null/PORTFOLIO_SMALL/view/preview.jpg", "featuredFile2": "/p/files/3/null/THUMB/view/preview.jpg", "featuredFile3": "/p/files/4/null/THUMB/view/preview.jpg", "setCount": 4, "fileCount": 18, "objective": "This is my objective.", "position1Title": "Administrator", "position1Duration": "2 years 1 month", "position1Details": "This is a badass job dude.", "position2Title": "Coffee Coordinator", "position2Duration": "2 years ", "position2Details": "This is my last job.", "lastUpdated": "2009-02-01T12:00:00Z" }

Or XML:

<profile>
	<id>1</id>
	<title>Title</title>
	<subtitle>Sub Title</subtitle>
	<public>true</public>
	<email>alternate@domain.com</email>
	<phone>248-555-1212</phone>
	<url>myurl</url>
	<lastUpdated>2009-02-01T12:00:00Z</lastUpdated>
	<expertise>Software</expertise>
	<secondaryExpertise1>Web Development</secondaryExpertise1>
	<secondaryExpertise2>Search</secondaryExpertise2>
	<professionalLevel>Senior/Director</professionalLevel>
	<fullTime>true</fullTime>
	<partTime>true</partTime>
	<relocate>true</relocate>
	<location>Troy, MI</location>
	<zipCode>48084</zipCode>
	<yearsExperience>10</yearsExperience>
	<education>Bachelor's Degree</education>
	<hasPortfolio>true</hasPortfolio>
	<hasResume>true</hasResume>
	<hasVoice>false</hasVoice>
	<bio>This is my bio.</bio>
	<featuredFile1>/p/files/PORTFOLIO_SMALL/view/preview.jpg</featuredFile1>
	<featuredFile2>/p/files/THUMB/view/preview.jpg</featuredFile2>
	<featuredFile3>/p/files/THUMB/view/preview.jpg</featuredFile3>
	<setCount>4</setCount>
	<fileCount>18</fileCount>
	<objective>This is my objective.</objective>
	<position1Title>Administrator</position1Title>
	<position1Duration>2 years 1 month</position1Duration>
	<position1Details>This is a badass job dude.</position1Details>
	<position2Title>Coffee Coordinator</position2Title>
	<position2Duration>2 years </position2Duration>
	<position2Details>This is my last job.</position2Details>
</profile>

Profile Activity Summary

Returns the number of visits to the profile of the authenticated user. Visits are recorded for every visitor that is not the profile owner.

URL: [GET] https://raveal.net/api/profile/activity-count.json (or .xml)

Required Parameters
  • none
Optional Parameters
  • startDate
    The start of the window of time to return activity for. In form of YYYY-MM-DD
  • endDate
    The end of the window of time to return activity for. In form of YYYY-MM-DD

If neither start nor end is supplied, the default date range is the current day.

Returns JSON:

{ "activityCount": INTEGER }

Or XML:

<activitycount>INTEGER</activitycount>

Profile Activity Detail

Returns a detailed list of visits to the profile of the authenticated user for the specified date range.

Visits are recorded for every visitor that is not the profile owner. If the visitor is a logged in Raveal user (company or individual), the name of the visitor is recorded. If the visit came from the Raveal search engine, the search terms will be recorded. If the visit came from a referring link, the full referrer will be recorded.

URL: [GET] https://raveal.net/api/profile/activity.json (or .xml)

Required Parameters

  • none

Optional Parameters
  • startDate
    The start of the window of time to return activity for. In form of YYYY-MM-DD
  • endDate
    The end of the window of time to return activity for. In form of YYYY-MM-DD
  • count
    The number of results to return. The actual number returned may be less than count. Defaults to 200.
  • page
    Specifies the page of results to return.

If neither start nor end is supplied, the default date range is the current day.

Fields returned may be empty depending on whether or not data was recorded for that visit.

Returns JSON:

[{ "viewer": "Visitor Name", "on": "YYYY-MM-DDT12:00:00Z", "referrer": "Website or link that referred the visit", "search": "Terms from Raveal Search", "what": "resume, portfolio, or voice" },{ ... }]

Or XML:

<activities>
	<activity>
		<viewer>Visitor Name</viewer>
		<on>Date of Activity (YYYY-MM-DDTHH:MM:SSZ)</on>
		<referrer>Website or link that referred the visit</referrer>
		<search>Terms from Raveal Search</search>
		<what>What was viewed: portfolio, resume, or voice</what>
	</activity>   
	<activity>
		...
	</activity>   
</activities>

Application Images

These images are available for use in your integrated applications. Talk to us if you need something different.