Apache Usergrid Documentation

Introduction

• Usergrid Features
  • Data storage & management
  • Geolocation
  • Push notifications
• Usergrid Data model
  • Organizations
  • Applications
  • Collections
  • Entities
  • Default entities
  • Properties
  • Default properties
• Async vs. sync calls
  • Synchronous
  • Asynchronous

Getting Started

• Creating a new application
  • Creating an application
  • Securing an application
• Creating an Usergrid Account
  • Next steps
• Using a Sandbox Application
  • What is the sandbox application?
  • Is the sandbox secure?
  • Creating a New Sandbox Application
• Using the API
  • Supported HTTP methods
  • Base URL
  • Request construction
  • Accessing collections
  • Accessing entities
  • Issuing queries
  • Authentication (OAuth)
  • Response format
  • SDKs

Data Storage

• The Usergrid Data Store
• Data Store Best Practices
  • Put your data in as you’ll want to get it out
  • Best practice: Denormalize for pre-computed query results
• Collections
  • Creating Collections
  • Retrieving Collections
• Entities
  • Creating Custom Data Entities
  • Creating multiple custom entities

Data Queries

• Querying your data
  • Basic query usage
• Query parameters & clauses
• Query operators & data types
  • Operators
  • Data types
• Advanced query usage
  • Attaching a query to all API calls

Entity Connections

• Connecting entities
  • Request syntax
• Retrieving connections
  • Request syntax
  • Retrieve all connected entities
  • Retrieve all connecting entities by type
  • Retrieve all connecting entities
• Disconnecting entities
  • Request syntax

Security & Authentication

• Security & token authentication
• Using permissions
  • Permissions syntax
  • Complex paths
  • Assigning permissions
• Authenticating users & app clients
  • Authentication levels
  • Application user authentication (user login)
  • Admin user authentication
• Authentication levels
  • Configuring authentication levels
  • User authentication level
  • Admin authentication levels
• Changing token expiration (time-to-live)
  • Default ttl
  • Changing the default ttl
• Authenticating API requests
  • Authenticating with access tokens
  • Authenticating with client ID and client secret
• Revoking tokens (logout)
  • Revoking tokens (user logout)
• Facebook sign in
  • Facebook login example
• Security best practices
  • Never use the ‘sandbox’ for a production app
  • Review permissions in your apps
  • Edit the ‘default’ role
  • Use https
  • Acquire access tokens in a secure way
  • Treat mobile clients as untrustworthy

User Management & Social Graph

• User management & social graph
  • User management
  • Group management
  • Social connections
  • Activity feeds
• Working with User Data
  • Creating users
  • Resetting a user password
• Working with group data
  • Creating groups
• Activity
  • Posting activities
  • Creating an activity for a user’s followers in a group
  • Retrieving a group’s activity feed
• Social Graph Connections
  • Following/followers
  • Creating a following/followers connection
• Creating other connections
• App Example - Messagee
  • Creating a user account in Usergrid
  • Creating an app and users

Geo-location

• Geolocating your Entities
  • Saving location data in an entity
  • Querying location data
  • Enrich your app with location data

Assets & Files

• Uploading assets
  • Uploading assets
• Retrieving assets
  • Retrieving asset data
  • Retrieving an asset entity
• Folders
  • Linking a folder to an asset
  • Retrieve list of folder assets

Counters & Events

• Counters & events
• Creating & incrementing counters
• Retrieving counters
  • Request syntax
  • Example request
  • Example response
  • Retrieving counters by time interval
  • Request syntax
  • Example request
  • Example response

Organizations & Applications

• Organization & application management
• Organization
  • Creating an organization
  • Activating an organization
  • Generating organization client credentials
  • Getting an organization’s activity feed
  • Adding an admin user to an organization
  • Removing an admin user from an organization
• Application
  • Creating an application
  • Getting application credentials

API Reference

• Methods

Client SDKs

• COMING SOON...

Installing the Stack

• Usegrid 1: Deploying to Tomcat
  • Requirements
  • Download
  • Building
  • Install and configure Cassandra
  • Install and configure Tomcat
  • Add Usergrid WAR to Tomcat
  • Add Usergrid configuration file to Tomcat
  • Run Usergrid Database & Super User Setup
  • Build the Usergrid Console
  • Login to the Usergrid Console & get started
  • Example usergrid-custom.properties file
• Usegrid 1: Launcher Quick-start
  • Requirements
  • Download
• Usergrid 2: Deploy to Tomcat
  • Requirements
  • Running

More about Usergrid

• Presentations & Videos
  • Building Mobile Apps with Apache Usergrid
  • How to Contribute to Apache Usergrid
  • Apache Usergrid Internals
  • Open Source Mobile Backend on Cassandra
  • Usergrid Overview
  • Cassandra at Apigee, Usergrid Powering Mobile
• How to Contribute Code & Docs
  • Code Contributions
  • Website and Documentation Contributions