API Guide v2.0

Login

HTTP Method & URL
POST <base-url>?Type=Login&Version=1
<query parameters>
Parameters
Type <required> Community
Version <required> API version#
UserId <required> LoginId for the API user.
Password <required> Plain text password
Description
This is the userid/password for the api user (not the end user who is using the Connectbeam application). If the login is successful, then it returns a cookie named "connectbeam".
Returns
HTTP Status Code: 200 (success) or 400 (bad request)

A cookie named connectbeam is returned if the login is successful. This cookie needs to be passed when calling any other API.

Notes:
  • The Login API does not automatically create a "personal" (private) group for the user. To create a "personal" group for the user, use the Create Group API. Each user of the Connectbeam application should have a "personal" group.

back to top

©2008 Connectbeam, Inc.