SoftwareShield CheckPoint™ License Server > CheckPoint License Server Interfaces > HTTP GET URL Interface
 

HTTP GET URL Interface


The CheckPoint License Server will respond to regular HTTP GET requests on its "HTTP GET URL Interface".  You can easily test the interface is available and responding by simply using a web-browser and navigating to a deployed CheckPoint server as shown in the below:

 

This is the default response from the SoftwareShield CheckPoint™ Server when it is called with a blank path.

You can use its HTTP GET Interface to:

  1. Dynamically generate new Serial Numbers.  This call also allows you to pass a collection of end user information to associate with the Serial Number you wish to generate.

  2. Dynamically add activations to existing Serial Numbers. This call allows you to let end-users purchase more activations (seats) of your software after they had already completed an initial purchase.

Either way - the URL for the HTTP GET interface is constructed the same way.  It will always have a set of components:

As you can see from the image there are five main components:

Component A: This is simply the http path to your CheckPoint License Server directory This part of the URL may be something like:  "https://secure.server.com/cp/"

Component B: This is always the same - the name of the ISAPI module "checkpoint.dll".

Component C: This is the action identifier.  You have two choices:  It must be either "nsn" for generating new serial numbers, or  "esn" for adding activations to existing serial numbers.  In the example shown above we are invoking the functionality to generate a new Serial Number (using "nsn").

Component D: This is always the CheckPoint administrators user credentials (user name and password) separated by an asterisk (*).  This is NOT the end user (clients) credentials. In the example above, the CheckPoint Administrator we are using is named "admin" and their password is "password".

Component E: This is the query string.  The parameters you use here will depend on which action you are invoking, the values you have available and wish to pass and any query parameter mapping you wish to use.  
 

More Information

If you wish to dynamically generate new Serial Numbers, see:  Generating Serial Numbers Dynamically for more specific information about the calling format and required and optional parameters including examples.

If you wish to add seats to an existing Serial Number, see: Adding Activations to Existing Serial Numbers for more information about the calling format and required and optional parameters including examples.

If you wish to use a query parameter name mapping to control what parameter names the CheckPoint Server will interpret, see: Map CheckPoint HTTP GET Query Parameters for more information including examples.

If you wish to control the return format of a successful call to the interface, see: Control CheckPoint HTTP GET Return Templates.
 

Related Topics

Note: The SoftwareShield CheckPoint™ License Server only comes with the Server Edition of the SoftwareShield System.