Difference between revisions of "XcelDataAPI:LicenseCheck"

From XcelData Wiki
Jump to: navigation, search
(Example of successful response (using dev store api key))
(Example of successful response (using dev store api key))
 
(One intermediate revision by the same user not shown)
Line 30: Line 30:
  
 
'''Note:'''
 
'''Note:'''
support-until: the actual date support is valid for (but this can be revoked at any time, so we instead check valid-until)
+
 
valid-until: will either be a date that is a few days into the future (server side setting may change), or the end of support date. Whichever happens first.
+
support-thru: the actual date support is valid through. This is for displaying somewhere to the customer (but this can be revoked at any time, so we instead check valid-thru)
 +
 
 +
valid-thru: will either be a date that is a few days into the future, or the end of support date. whichever happens first. (this is so superpawn is only "internet-less" for no longer than a week or so)
  
 
====What if the internet is down?====
 
====What if the internet is down?====
 
# Is there a previous response on file?
 
# Is there a previous response on file?
 
## No: Sorry, you need the internet to register the first time
 
## No: Sorry, you need the internet to register the first time
## Yes: Look at the previous valid response. Is today less than or equal to the valid-until date?
+
## Yes: Look at the previous valid response. Is today less than or equal to the valid-thru date?
 
### No, Sorry it's been a week since you last validated, we must check before we can start up.
 
### No, Sorry it's been a week since you last validated, we must check before we can start up.
 
### Yes: Superpawn may start up!
 
### Yes: Superpawn may start up!

Latest revision as of 17:32, 18 April 2018

This article documents features that are still in development.

Information may change rapidly as the event progresses, or if requirements change. The last updates to this article may not reflect the most current information.


URL Structure

https://api.xceldata.com/0.1/license-check/[output-format]/[software-id]/[apikey]

URL Variable Breakdown

output-format

string: xml or json

Specifies XML or JSON output.

software-id

string: superpawn or xpawn

Specifies which program to lookup a license for

api-key

string: a valid store api key

Store API keys can be obtained from app.xceldata.com/customers

Example of successful response (using dev store api key)

https://api.xceldata.com/0.1/license-check/xml/superpawn/1E17162A-8355-4FF2-8DCD-E5CEE676FD93

https://api.xceldata.com/0.1/license-check/json/superpawn/1E17162A-8355-4FF2-8DCD-E5CEE676FD93

A successful response will include store info as well as dates for when the software is considered "legit"

Note:

support-thru: the actual date support is valid through. This is for displaying somewhere to the customer (but this can be revoked at any time, so we instead check valid-thru)

valid-thru: will either be a date that is a few days into the future, or the end of support date. whichever happens first. (this is so superpawn is only "internet-less" for no longer than a week or so)

What if the internet is down?

  1. Is there a previous response on file?
    1. No: Sorry, you need the internet to register the first time
    2. Yes: Look at the previous valid response. Is today less than or equal to the valid-thru date?
      1. No, Sorry it's been a week since you last validated, we must check before we can start up.
      2. Yes: Superpawn may start up!