Skip to content

Staging versus production#

There are two API endpoints you can access and two OAuth endpoints available for your use:

API#

  • Production: https://api-production.august.com
  • Staging: https://staging.august.com

You should always develop against Production because that is the stable API.

The only time you might want to use Staging would be to test upcoming releases or features to see if they break your application.

Not all Staging releases make it to Production, so don't count on features you see there being available in Production.

API Revision#

You can call GET /revision on both Production and Staging to see the version of the API you are using. This can be helpful in bug reporting and also spotting when a revision gets promoted from Staging to Production.

Let us know if Staging breaks something for you!

If you find that an August API Staging release breaks your application, please let us know and we can take that into consideration before pushing those changes to Production. We'll avoid breaking your app if we can. So far (as of 2016-July) we've never broken a partner's app in Production.

OAuth#

  • Production: https://auth.august.com
  • Staging: https://staging-oauth.august.com

There is a separate OAuth server for Staging, https://staging-oauth.august.com, but you should rarely need to use it. The only time to use the staging OAuth server is if you want to test some change to the August OAuth flow.

All 4 combinations should work:

  1. Production OAuth + Production API
  2. Production OAuth + Staging API
  3. Staging OAuth + Production API
  4. Staging OAuth + Staging API

Use Production

So always use Production unless there is a new feature on Staging you need to test.

Application#

You can point your August Application to staging as well, with these steps:

  1. Log out of the August Application if you're already logged in.
  2. Start the August App and click Sign In
  3. Click on SIGN IN WITH EMAIL INSTEAD
  4. Enter DreadfulDow for both email address and password.
  5. Click on Next or the check mark to proceed.
  6. On the top of the screen you should now see https://.... some server name with a drop-down menu. Use this to choose https://staging.august.com
  7. Click on Save and that should take you back to the sign-in screen.
  8. Enter your phone number and password and sign in as normal.

Now you should be on staging with your application. If you want to switch back to production, follow the same steps but when it comes to the drop-down of server names, choose https://api-production.august.com