📘

About the Deeplinking API

The Deeplinking API allows you to construct URLs that will load a specific entry in Maximizer. You should use the Deeplinking API when you want to redirect a user from a function or page within your app to the related entries in Maximizer. For example, if you were building a quote management tool, you might want to display a button or link that would let the user open the Maximizer entry associated with a given quote automatically, without having to open Maximizer and perform a search to find the same entry.

With the Deeplinking API, you can construct links that will open an entry in the Address Book, Opportunities, Customer Service, or Hotlist page. When your app performs a redirect to a Deeplinking URL, or when the user clicks the link, the Maximizer page will open with the specified entry selected in the list. If the user is not already logged-in to Maximizer, they'll be presented with the login page, and after entering their username and password, the entry will be displayed.

Deeplinking How-To

In order to construct a deeplinking URL, you need the Key of the entry that you want to display in Maximizer. To look up the Key of a Maximizer entry, you will need to search for the entry using Maximizer API.

The format of deeplinking URLs depends on the Maximizer platform you are using--Maximizer CRM Live or Maximizer CRM On-Premise. Once you have the Key of the entry, you can construct the deeplinking URL using the URL structure that corresponds to your platform using one of the formats below.

Note that all parameters in the link must be URL-encoded, including any special characters such as the "=", "+", or "/" characters that may be included in the Key of a Maximizer entry. The opening ( and closing ) parentheses in the "KEY("{key}")" portion of the URL, may also be encoded to %28 and %29 respectively. For more information on URL encoding refer to the MDN documentation.

Maximizer CRM Live URL Format

{MaximizerCRMLiveURL}/{Alias}?{Module}=KEY({Key})

The merge values in {curly braces} in the URL above should be specified as follows:

• {MaximizerCRMLiveURL} - This is the URL of Maximizer CRM Live in the region where your account is hosted. For example, "https://caw.maximizercrmlive.com" for the North American region or "https://ukw.maximizercrmlive.com" for the European region.
• {Alias} - This is the account alias belonging to your Maximizer CRM Live which forms part of your login URL. For example, if the login URL of your Maximizer CRM Live account is "https://caw.maximizercrmlive.com/example", then the alias of your account is "example".
• {Module} - This is the module that you want to display. The following options may be used:
  • ss - The Address Book page.
  • ssopp - The Opportunities page.
  • sscscase - The Customer Service page.
  • sshotlist - The Hotlist page.
• {Key} - This is the key of the entry that you want to display in Maximizer. The Key must be for the appropriate type of entry depending on the Module that you've selected. In other words, you can't supply the Key of an Opportunity to the Customer Service page. You'll need to retrieve this Key by searching for the entry using Maximizer API. You must ensure that the parameter containing the Key is properly URL-encoded.

For example, here's a deeplinking URL for an Address Book entry in an example Maximizer CRM Live database:

https://caw.maximizercrmlive.com/example?ss=KEY%28Q29udGFjdAlERU1PXzFDCTE%3D%29

Maximizer CRM On-Premise URL Format

{MaximizerWebAccessURL}/default.aspx?ab={DatabaseName}&{Module}=KEY({Key})

The merge values in {curly braces} in the URL above should be specified as follows:

• {MaximizerWebAccessURL} - This is the URL of Web Access, where you would normally browse to log in to Maximizer Web Access or Maximizer CRM Live. For example, "https://www.example.com/maximizerwebaccess".
• {DatabaseName} - This is the database name of the Address Book that you want to open. Note that this is the actual database name, not the "friendly name" that is displayed on the login page, and does not contain any spaces or special characters. For example, "EsconaTutorial".
• {Module} - This is the module that you want to display. The following options may be used:
  • ss - The Address Book page.
  • ssopp - The Opportunities page.
  • sscscase - The Customer Service page.
  • sshotlist - The Hotlist page.
• {Key} - This is the key of the entry that you want to display in Maximizer. The Key must be for the appropriate type of entry depending on the Module that you've selected. In other words, you can't supply the Key of an Opportunity to the Customer Service page. You'll need to retrieve this Key by searching for the entry using Maximizer API. You must ensure that the parameter containing the Key is properly URL-encoded.

For example, here's a deeplinking URL for an Address Book entry in an Escona Tutorial database on a fictional example server:

https://www.example.com/maximizerwebaccess/default.aspx?ab=EsconaTutorial&ss=KEY%28QWJFbnRyeQkxNjAyMTgyNTA3MjQ0MDQwNTAwMDNDCTM%3D%29