Realmassive

Quickstart Guide

Quickstart Guide

Welcome! Here, we demonstrate how to quickly get started using our API. We start with some quick facts for experienced developers and then move to showing you how to make your first authorized API calls.

Quick Facts

  1. Our API...
  2. We have a sandbox environment for you to test in. Its database is a copy of production, however it's completely separated from the production environment. Once you're ready to move to production, contact us for production API access.
  3. Endpoints
    • Sandbox
      • Root Endpoint: https://api-sandbox.realmassive.com/
      • Login: https://sandbox.realmassive.com/accounts/login
      • Signup: https://sandbox.realmassive.com/accounts/signup
      • Access Token Refresh: https://sandbox.realmassive.com/accounts/refresh
    • Production
      • Root Endpoint: https://api.realmassive.com/
      • Login: https://realmassive.com/accounts/login
      • Signup: https://realmassive.com/accounts/signup
      • Access Token Refresh: https://realmassive.com/accounts/refresh

Your First API Calls

Now that the basics are out of the way, we will show you how to login a user, store that user's access_token and use that token for subsequent authenticated calls.

Login
# Login using Basic Auth.
$ curl -XPOST -H "Content-Type: application/json" \
-d '{"email": "api-demo@realmassive.com", "password":"my-pw"}' \
https://sandbox.realmassive.com/accounts/login
{
  "access_token": "eyJ...SI",
  "token_type": "Bearer",
  "expires_in": 3600,
  "user": {
    "relationships": {
      "cards": {
        "links": {
          "related": "/users/1364688202639607091/cards"
        }
      },
      "memberships": {
        "links": {
          "related": "/users/1364688202639607091/memberships"
        }
      }
    },
    "attributes": {
      "updated": "2016-10-19T18:58:52.815530+00:00",
      "tos_status": "ACCEPTED",
      "email": "jason.vertrees+apidemo@realmassive.com",
      "created": "2016-10-19T18:58:52.815530+00:00"
    },
    "type": "users",
    "id": "1364688202639607091"
  },
  "refresh_token": "am..Iz"
}
                
Make Authenticated API Calls

You can now make authenticated calls to our API by passing the access_token you received in the prior step in the Authorization header as the Bearer Token.

# Get this user's information.
$ curl -XGET -H "Authorization: Bearer eyJ...SI" \
https://api-sandbox.realmassive.com/users/1364688202639607091
$ curl -XPOST -H "Authorization: Bearer YOUR-ACCESS-TOKEN" \
https://rm-api-sandbox.appspot.com/spaces?page[limit]=1

See the RealMassive API Reference for detailed information on all 300+ routes.