Using the KeyGen API

Basics

The API url is https://keygen.matiboux.com/scripts/api.php. The script returns a JSON response for every handled request.

The parameters can be passed by POST or GET requests. This documention will use GET requests as example.

Modes

There is three supported modes : keygen, cd-key, passphrase, and random. Just specify the mode with the "mode" parameter. Additional supported parameters can be added to the request.

• ?mode=keygen — Generate a random keygen
  Parameters:
  • numeric — Allow numeric characters (boolean, default: true) (alias num)
  • lowercase — Allow lowercase characters (boolean, default: true) (alias low)
  • uppercase — Allow uppercase characters (boolean, default: true) (alias upp)
  • special — Allow special characters (boolean, default: false) (alias spe)
  • length — Set the generated key length (number, default: 12) (alias len)
  • redundancy — Allow characters to appear multiple times (boolean, default: true) (alias red)


• ?mode=cd-key — Generate a random CD key
  Parameters:
  • numeric — Allow numeric characters (boolean, default: true) (alias num)
  • lowercase — Allow lowercase characters (boolean, default: true) (alias low)
  • uppercase — Allow uppercase characters (boolean, default: true) (alias upp)
  • special — Allow special characters (boolean, default: false) (alias spe)
  • length — Set the generated key length (number, default: 12) (alias len)
  • blocks — Set the number of blocks (number)
  • redundancy — Allow characters to appear multiple times (boolean, default: true) (alias red)


• ?mode=passphrase — Generate a random passphrase
  Parameters:
  • language — Dictionary language (string) (alias lang)
    Supported languages:
    • Engligh: en
  • length — Number of words (number) (alias len)


• ?mode=random — Generate a random number
  Parameters:
  • minimum — Minimum value (number) (alias min)
  • maximum — Maximum value (number) (alias max)
  Note: The minimum and maximum values are included in the range.