user/create_anon

URL

https://api.geoloqi.com/1/user/create_anon

Description

Create a new anonymous account. Returns an OAuth access token on success. This method is for the mobile clients to bypass signup and start using the app immediately.

Authentication

You must provide the API Key (Client ID) for this method, but the API Secret is not required. This means you do not need to include your client secret in your mobile apps.

If sending the client_id in post parameters, you can just omit the client_secret parameter. If you are using HTTP Basic Auth, you can use an empty string for the password.

Supported Request Methods

POST

Parameters

The request must be authenticated with the application's client ID and secret. You can do this by either passing them in post parameters or by using HTTP Basic auth.

• client_id
  Your application's client ID

Alternatively, you can pass the authentication in via HTTP Basic auth if you are using a library that supports it. Use the client ID as the username and leave the password blank. See API/Authentication for more information.

Optional

• key
  A unique identifier for the user. Repeated API calls to user/create_anon with the same key value will not create a new account. Instead, the existing account's access token will be returned instead. You can use this to integrate Geoloqi user accounts with external user databases. See the page on De-Duplication for more information.
  NOTE: You cannot use the "key" property from a mobile device or Javascript app, as this would be a major security hole allowing any user to log in as any other user if they know other keys.
• extra
  A hash of keys and values to store along with the user. Whatever you store here will be returned whenever the user profile is read. See Extra Parameters for more details.
• device_id
  If the account is being created from a mobile device, a UUID should be generated and sent at this time. This UUID will also be used when sending UDP location updates.
• mac
  If the account is being created from a mobile device, the MAC address of the wifi adapter should be sent.
• apn_token
  For iPhones, if the app has already registered for push notifications before calling create_anon, the token can be sent at this time.

Layers and Groups

You can automatically subscribe users to a layer or add them to a group when they are created. To do this, use the "layer_ids" and "group_tokens" parameters when creating the user.

• layer_ids
  An array of one or more layer IDs the user should be subscribed to when created. The layer must be "public", since this is equivalent to immediately running layer/subscribe/:id after the account is created.
• group_tokens
  An array of one or more group tokens the user should be added to when created. The groups must be "public" or "open" since this is equivalent to immediately running group/join/:token after the account is created.

Response

Success

On successful account creation, the response is identical to a call to oauth/token and will contain an access token and refresh token. The mobile client should make sure not to lose the refresh token, since the user has no password at this point and will have no way to log in via the mobile app until creating a password on their computer.

{
  "access_token": "RsT5OjbzRn430zqMAZFh+QaLgVx+Q3Ia",
  "expires_in": 3600,
  "scope": null,
  "refresh_token": "e1qoXgfno1YTKc7aAZvIk2RRua48lXIV"
}

Error

You will get a descriptive error message if there was a problem creating the account. See Error Codes for more information.

{
  "error": "access_denied",
  "error_description": "This client does not have permission to create anonymous accounts"
}