XcelDataAPI:LicenseCheck

From XcelData Wiki
Revision as of 23:03, 17 April 2018 by Charliej (talk | contribs) (Created page with "{{InDev}} =URL Structure= <nowiki>https://api.xceldata.com/0.1/license-check/[output-format]/[software-id]/[apikey]</nowiki> ==URL Variable Breakdown== ===output-format===...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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/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-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.

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-until 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!