API Guide v2.0

What's New

Overview
  • The v2.0 Connectbeam APIs are available with the R3.1 of the Connectbeam Spotlight application. All 1.x APIs are fully supported with this release, so there is no need to make updates to your current API calls.
  • In order to use the v2.0 APIs, the Version attribute used in making the calls to the APIs should be set to 2. For example:
    GET http://tags.company.com/cbapp/restapi?Type=Bookmark&Version=2&BookmarkId=500& UserId=500
  • The APIVersion tag in the response header will reflect the version of the API called. For example: <APIVersion>2.0</APIVersion>
  • APIs that have not received updates for v2.0 can still be called as Version=2 APIs. This eliminates the need to manage mixed API version calls for new application development.
  • The primary update in v2.0 from v1.1 is in the XML response for all APIs which return bookmark information. For these APIs, the <Community> section of the response has been updated to include the group type (open, restricted, private, company).

NOTE: If you are new to the Connectbeam Spotlight APIs, be sure to read the API Summary page.

back to top

©2008 Connectbeam, Inc.