Testit licensing API

Rest API for Testit licensing

Table of contents

• Description
• Coding documentation
• Endpoint definitions
  • Check license
  • Create license
  • Check test-license
  • Create test-license
• Developement team
• Copyright / License

Description

For the two Test it products, Test it lab and Test it field, a certification authority is required, which we have implemented with a PHP REST API. The respective software checks at the start or in offline mode after a defined period of time whether the license is still valid. This is enabled by a defined endpoint of the REST API. The database distinguishes between purchased and test licenses.

Coding documentation

The API contains the four folowing main files:

• license-management/index.php
• controller/LicenseController.php
• gateways/TestLicenseGateway.php
• config/database.php

The access point "index.php" splits the URL, gets the request method and checks if the endpoint is accessed correctly. This information is passed to the "LicenseController.php" together with the database connection. Depending on the type of access method (GET, POST, DELETE) the license controller selects the respective option. The various functions prepare the data to be forwarded to the gateway later or directly to the output. In an MVC environment, this controller would take over the function of the view and the controller. The model in this case is the "TestLicenseGateway.php" that creates the database queries and returns them to the controller. The database connection is established in "database.php".

Endpoint definitions

The REST API has endpoints for the following purposes:

• Check license
• Create license
• Check test-license
• Create test-license

Check license

GET /lizenz-managment/license/{product}/{udid}

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam

Create license

POST lizenz-managment/license/

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam

Check test-license

GET /lizenz-managment/test-license/{product}/{udid}

Response if valid:

{
    "valid": "true",
    "valid_until": "2021-07-22T16:53:57+0200"
}

or if not valid:

{
    "valid": "false",
}

Create test-license

POST lizenz-managment/test-license/

Example of body (header):

{
    "product" : "test-it-lab",
    "udid": "d6cbfc24-040d-454f-b5d2-8fbeee611c31",
    "ip": "192.168.2.1",
    "device_information": "10.12.6, 00:1B:44:11:3A:B7, 2"
}

Developement team

• @sandroanderes

Copyright / License

Copyright 2021

This software is distributed under the MIT license. For more information, see 'LICENSE'.