License Format Object

by Andrés Jacobo (AJ) González (Last updated:  Tuesday, June 25, 2019)

Note: Not all format possibilities are described in this document. If your license keys have a format that cannot be accurately defined in the fields below, we might be able to help. Please contact aj@mcneel.com for details.

Structure

"format": {
    "length": {
        "min": 24,
        "max": 48
    },
    "prefix": "RMA7-",
    "example": "RMA7-XXXX-XXXX-XXXX-XXXX-XXXX",
    "regexFilter": "[A-Za-z0-9]"
},

Description

  • length - A range of min and max integers representing the minimum and maximum characters–inclusive–a license key is expected to contain. To avoid conflicts with other formats, this number should be as specific as possible. Note that the length is for the overall license key and includes the characters in the prefix.
  • prefix - A string representing the common prefix a license key is expected to begin with. The prefix should be as specific as possible to avoid conflicts with other formats.
  • example - An example license key that may be shown to the user when entering a license. It should begin with the prefix specified.
  • regexFilter- (optional) - A regular expression defining the allowed characters in the license key. By default, only characters A-Z (both lowercase and uppercase) and numbers 0-9 are allowed. Whitespace, dashes, and slashes will not be considered for a pattern match.