API Endpoints

register

Register will create a new user. POST data must contain the following:

• API key
• email - will be checked for syntax errors
• firstname
• lastname
• password
• tzn

Optional parameters are:

• username - If provided will be checked for syntax error. Will be synthesized if not provided.
• gll

Method	Description
/register	See Example1 and 2 for register JSON data structure without and with gll data

Example1: register - no gll in post data

POST http://api.hipgeo.com/register?access_token=TOKENVALUE

POST http://api.hipgeo.com/register

Data:
{
   "apikey":"GraphApiUtil::HIPGEO_API_KEY",
   "email":"johnny@yahoo.com",
   "firstname":"John",
   "lastname":"Doe",
   "password":"johnpasswd",
   "username":"johnnyd",
   "tzn":"America/Denver",
   "facebook":{
      "page_id":"100000844496018",
      "access_token":"6Pg0PsqUeLH--TRUNCATED--l6iKsDptQda8KAXOjg"
   },
   "twitter":{
      "oauth_token_secret":"oL8SbthCEqZyDTZTJBo9pdjDAwBMGGiy4MUfeGlAI",
      "oauth_verifier":"6581540",
      "user_id":"333225519",
      "screen_name":"pkg172",
      "oauth_token":"333225519-WxjyA2SMqNH9NZLbfvQl6b4SWVIrGvlrw5XzW54F"
   }
}

Returns:
{
  "id":"u_579",
  "user":{
    "id":"u_579",
    "name":"johnnyd",
    "shareable":1,
    "pingable":0,
    "fullname":"John Doe"
  },
  "auth_token":"johnnyd_076e5258b56fd8176acf555a3fcc354f591f512a",
  "result":"success"
} 

Error Code

Possible Errors

400

Invalid request Authentication failed Unable to parse data Invalid api key email - Email address is required email - Not a valid email address email - anything@hipgeo.com is invalid email - Email is too long email - This email is already used username - Sorry, this user name is taken username - HipGeo is not allowed in names username - Spaces are not allowed in names username - Only letters and numbers username - Must contain a letter password - Password is required password - Must be at least 6 characters password - Password cannot be over 20 characters password - Only letters, numbers and !@#$%^&*-_ firstname - Only letters are allowed lastname - Only letters are allowed

Example2: register - with gll in post data

POST http://api.hipgeo.com/register?access_token=TOKENVALUE

POST http://api.hipgeo.com/register

Data:
{
	"apikey":"GraphApiUtil::HIPGEO_API_KEY",
	"email":"john@yahoo.com",
	"firstname":"John",
	"lastname":"Doe",
	"password":"johnpasswd",
	"username":"johnd",
        "gll":{
               "lat":33.9867,
               "lon":-117.827,
               "hacc":1,
               "vel":0,
               "when":"2011-04-25 23:43:26"
         }
}

Returns:
{
  "id":"u_475",
  "user":{
    "id":"u_475",
    "name":"johnd",
    "shareable":1,
    "pingable":0,
    "fullname":"John Doe"
  },
  "auth_token":"johnd_076e5258b56fd8176acf555a3fcc354f591f512a",
  "location":{
    "id":"l_35280",
    "shareable":1,
    "title":"Diamond Bar, CA",
    "duration":0,
    "duration_sec":0,
    "uid":"u_475",
    "type":1
  },
  "result":"success"
} 

Error Code

Possible Errors

400

Invalid request Authentication failed Unable to parse data Invalid api key email - Email address is required email - Not a valid email address email - anything@hipgeo.com is invalid email - Email is too long email - This email is already used username - Sorry, this user name is taken username - HipGeo is not allowed in names username - Spaces are not allowed in names username - Only letters and numbers username - Must contain a letter password - Password is required password - Must be at least 6 characters password - Password cannot be over 20 characters password - Only letters, numbers and !@#$%^&*-_ firstname - Only letters are allowed lastname - Only letters are allowed