Migrating from the Legacy Cloud Endpoints

How to move an existing integration from the region-specific OAuth endpoints to the current Maximizer Cloud endpoints.

This guide is for integrations built against the previous region-specific Maximizer Cloud OAuth endpoints:

https://{region}.maximizercrmlive.com/OAuth2/{company_alias}/Authorize
https://{region}.maximizercrmlive.com/OAuth2/{company_alias}/Token

These endpoints continue to work, and the current endpoints preserve the same request and response formats.

Migration Steps

To migrate an existing integration:

  1. Replace the legacy Authorize and Token URLs with the current endpoints: https://auth.maximizer.com/v1/authorize and https://auth.maximizer.com/v1/token.
  2. Have your users complete a new authorization (Authorization Code Flow, Steps 1–4) to obtain fresh tokens.
  3. Replace any stored tokens with the newly issued ones.

Things to Take Into Account

  • Tokens are not interchangeable. A refresh token issued through the legacy endpoints cannot be used at the current endpoints, and vice versa. This is why a new authorization is required: stored refresh tokens cannot be carried over.
  • Refresh tokens are longer. The current endpoints issue refresh tokens as signed JWTs, which are significantly longer than the legacy tokens. Make sure your token storage does not assume a short or fixed length.
  • Token request parameters must be sent in the request body. The legacy endpoints tolerated token request parameters in the URL query string; the current Token endpoint ignores query parameters and only reads the form-encoded request body.
  • The sign-in experience changes. Users sign in with their e-mail address instead of being sent to a region- and account-specific login page. Your application no longer needs to know the user's region or account alias.