This API serves as a layer that simplifies communication with Serial Key Manager Web API 2 and 3 (https://serialkeymanager.com/docs/api).
###Web API versions In Web API 2, authentication usually contains variables such as "pid", "uid" and "hsum". In Web API 3, authentication is performed using access tokens (https://serialkeymanager.com/docs/api/v3/Auth). ###Examples Use cases, examples in different languages, and examples that are not shown here can be found at:
- https://support.serialkeymanager.com/ac/skgl-extension
- https://support.serialkeymanager.com/ac/examples
The original repository of this project was: https://skgl.codeplex.com/. NB: This is only SKGL.SKM, not the entire SKGL API.
##How to use
- Key Validation
- Key Activation
- Offline Key Validation
- List User Products
- Get Product Variables
- Check Against Time Rollback
- Other Methods in Web API
- Calculating Machine code
###Key Validation For pid, uid and hsum, please see https://serialkeymanager.com/Ext/Val. You can retreive them using Get Product Variables.
public void KeyValiation()
{
var validationResult = SKGL.SKM.KeyValidation("pid", "uid", "hsum", "serial key to validate");
if (validationResult != null)
{
//valid key
var created = validationResult.CreationDate;
var expires = validationResult.ExpirationDate;
var setTime = validationResult.SetTime;
var timeLeft = validationResult.TimeLeft;
var features = validationResult.Features;
}
else
{
//invalid key
Assert.Fail();
}
}
###Key Activation For pid, uid and hsum, please see https://serialkeymanager.com/Ext/Val.
NB: If trial activation is configured, the API can return a new key (read more here).
public void KeyActivation()
{
var validationResult = SKGL.SKM.KeyActivation("pid", "uid", "hsum", "serial key to validate", "machine code", {sign the data}, {sign machine code});
if (validationResult != null)
{
//valid key
var created = validationResult.CreationDate;
var expires = validationResult.ExpirationDate;
var setTime = validationResult.SetTime;
var timeLeft = validationResult.TimeLeft;
var features = validationResult.Features;
}
else
{
//invalid key
Assert.Fail();
}
}
###Offline key validation Read more about offline key validation here.
public static void OfflineKeyValidationWithPeriodicTimeCheck()
{
var RSAPublicKey = "RSA public key";
var keyInfo = new KeyInformation().LoadFromFile("license2.txt");
if (keyInfo.HasValidSignature(RSAPublicKey, 30)
.IsOnRightMachine()
.IsValid())
{
// the signature is correct so
// the program can now launch
}
else
{
var machineCode = SKGL.SKM.getMachineCode(SKGL.SKM.getSHA1);
keyInfo = SKGL.SKM.KeyActivation("3", "2", "751963", "MJAWL-ITPVZ-LKGAN-DLJDN", machineCode, secure: true, signMid: true, signDate: true);
if (keyInfo.HasValidSignature(RSAPublicKey)
.IsOnRightMachine()
.IsValid())
{
// the signature is correct and the key is valid.
// save to file.
keyInfo.SaveToFile("license2.txt");
// the program can now launch
}
else
{
// failure. close the program.
}
}
}
###List User Products
public void ListAllProducts()
{
var listOfProducts = SKGL.SKM.ListUserProducts("username", "password");
foreach (var product in listOfProducts)
{
Debug.WriteLine("The product with the name \""+ product.Key + "\" has the pid \"" + product.Value + "\"");
}
}
###Get Product Variables This will get pid, uid and hsum.
public void GetProductVariables()
{
var listOfProducts = SKGL.SKM.ListUserProducts("username", "password");
//variables needed in for instance validation/activation
//note, First requires System.Linq.
var productVar = SKGL.SKM.GetProductVariables("username","password", listOfProducts.First().Value);
Debug.WriteLine("The uid=" + productVar.UID + ", pid=" + productVar.PID + " and hsum=" + productVar.HSUM);
}
###Check Against Time Rollback In order to make sure that the local time (date and time) wasn't changed by the user, the following code can be used.
public void HasLocalTimeChanged()
{
bool hasChanged = SKGL.SKM.TimeCheck();
if(hasChanged)
{
Debug.WriteLine("The local time was changed by the user. Validation fails.");
}
else
{
Debug.WriteLine("The local time hasn't been changed. Continue validation.");
}
}
###Other Methods in Web API If you would like to access a method in the Web API manually, please use GetParameters method. A list of them can be found here.
public void GetParamtersTest()
{
var input = new System.Collections.Generic.Dictionary<string, string>();
input.Add("uid", "1");
input.Add("pid", "1");
input.Add("hsum", "11111");
input.Add("sid", "ABCD-EFGHI-GKLMN-OPQRS");
input.Add("sign","true");
var result = SKGL.SKM.GetParameters(input, "Validate");
var keyinfo = SKGL.SKM.GetKeyInformationFromParameters(result);
if(result.ContainsKey("error") && result["error"] != "")
{
Assert.Fail();
}
}
###Calculating Machine code Machine code can be calculated with the function below. Any other hash algorithm will do, as long as it only contains letters and digits only.
public void TestingHashes()
{
//eg. "61843235" (getEightDigitsLongHash)
//eg. "D38F13CAB8938AC3C393BC111E1A85BB4BA2CCC9" (getSHA1)
string machineID1 = SKGL.SKM.getMachineCode(SKGL.SKM.getEightDigitsLongHash);
string machineID2 = SKGL.SKM.getMachineCode(SKGL.SKM.getSHA1);
}