Skip to main content

Developing against Test

Build and test your integration against the AgencyMax Test environment. Use Production only for your live integration.

Why Test​

  • Releases reach Test first. Every API release goes to Test before Production. When you build against Test, you see new features and behavior changes before they reach your live integration. You have time to adapt.
  • The API Portal uses Test. The interactive API reference in the API Portal sends its requests to the Test environment. So the requests you try in the portal behave the same way as the ones your code sends to Test.
  • Live data stays safe. Production holds live agency data. In Test, a bug in your integration can't change real agents, payees or hierarchies.

What's in Test​

Test is often a release or two ahead of Production. The Release Notes show the latest release of each API in both environments. Each release note shows the date the release reached Test and the date it reached Production. Not yet released means the release hasn't reached that environment yet.

Before your live integration relies on something you built in Test, check that the release that added it has reached Production.

Working in Test​

  • Get Test credentials. Subscription keys and OAuth clients are issued per environment. A Test key or token won't work in Production, and a Production key or token won't work in Test. See Environments and base URLs.
  • Use made-up data. Don't copy live agency data, such as personal details or tax information, into Test.
  • Expect resets. Test data may be reset. Don't rely on records you created in Test being there later. Have your tests create the data they need.

Going to Production​

When your integration works against Test:

  1. Check the release notes. Make sure every API release your integration depends on has reached Production.
  2. Get Production credentials. Ask your AgencyMax representative for a Production subscription and OAuth client for your tenant.
  3. Switch by configuration. Keep the gateway URL, subscription key and OAuth client settings in configuration, not code. Then the same build runs in both environments.
  4. Run a quick check. Make a few read-only calls in Production before you turn on writes.

After you go live, keep testing in Test. Run your integration tests there when a new release reaches Test, before that release reaches Production.