Control License Manager API

Control License Manager API

Welcome to the Control License Manager!

The Control License Manager (CLM) is a web service that resides at Cyrious’ home offices. The CLM service is used as the validation server for individual CHAPI services running at customer locations. It supports a REST interface via an HTTPS connection for all inquiries.

  • Supported REST operations

    Resource

    Supported Calls
    Licenses

    GET ../clm/license(<<id>>) ? nonce=s

    Gets the license information for the specified ID. The current validation code is required, and a new validation code is provided for subsequent requests. The body of the response contains information about the current licenses, the number of authorized and available licenses for each type, etc.

    If the ID or validation code is not valid, a 4xx is returned.

  • License Resource Structures

    Response Data Structure for ../chapi/license/<<id>>

    {"securityid": "0627836B-FBFB-44AD-AED2-875DA6A47379",

    "nonce": "00000000-0000-0000-0000-000000000000",

    "ispermanentauth": true,

    "licenseexpirationdate": "2113-01-01T00:00:00",

    "allauthorized": false,

    "controlauthorized": true,

    "controlversion": "Control 5.1",

    "controllevel": "Platinum",

    "controllicenses": 99,

    "divisionlicenses": 99,

    "ptlicenses": 99,

    "storelicenses": 99,

    "supportexpirationdate": "2010-12-31T00:00:00",

    "modules": "Accounting,Customizable,Parts,Inventory,FedEx,UPS,CreditCard,OnlineTax,Payroll,WebView"

    }

  • License Information Transmitted

    The following information is stored in the CHAPI configuration file under the <License> section:

    string ID Cyrious’ tracking ID for the store. This was formerly the dongle number.
    url URL The URL for the validation service.
    datetime NewValidationKey A private hash of the ID, computer’s processor ID, and authorization information that is generated by the Cyrious validation server. This ValidationKey must be sent with all license requests
    datetime SupportExpDate The date their support contract expired.
    string ControlLevel The level of Control authorized. Valid values include: Gold, Silver, Platinum
    int AuthorizedControlUsers The maximum number of simultaneous users authorized to run Control.
    int AuthorizedPTUsers The maximum number of users enabled for Production Terminal in employee setup.
    string[] Modules An array of the modules authorized for this user. Valid values include: Basic, Accounting, Tax, Parts, Inventory

  • Technical Appendix Service Specifications

    Language C# .NET 4.5
    Application Mode Windows Service
    Permissions Local Services (by default)
    Connection REST
    Data Format JSON or XML (based on accept-type; JSON by default)
    Protocol HTTP or HTTPS. (HTTPS recommended)
    Port 42066 (by default)
    Login Credentials Basic Authentication with Password Hash Client Authentication