Codelayer API Documentation

  • Introduction

    • General
  • API Reference

    • System

      • License request
      • Register Device
      • Authentication
    • Sales

      • Add Customer
      • Check Customer
      • Device Location
      • Master Place
      • Master Routes
      • Product Summary
      • Return details
      • Route Customers
      • Route Details
      • Route Path
      • Route Products
      • Route Products Return
      • Route Report
      • Route Return
      • Route Salesmen
      • Route Save
      • Route Save With Remarks
      • Route Shops
      • Sales Closing
      • Stock Transfer
      • Update Device Token
    • Response Codes
Codelayer API Documentation
License request

This is the URL to request the lisense and the location of the base url of the service. This request should be done to https://license.codelayer.co.in/

URL

system/license

Method

POST

Request Media type

application/json

Response Media type

application/json

Request Parameters
Parameter Data Type Min Max M/O Sample Value Comments
imei String 14 50 M 12345678901234 IMEI of the accessing device
appID String 3 30 M QM_V3 Application ID of the requesting application. this is the same application ID provided to the front end developer for registering the device.

 

Response Values
Name Data Type Min Length Max Length M/O Sample Value Comments
licenses Array 1 M List of the licenses for the device.
statusCode Integer 1 3 M 2 Status code.
1 = Approval Pending
2 = Approved
3 = Rejected
productName String 100 M Quarry Manager - Version III Name of the product.
clientName String 50 M Codelayer Technologies Pvt. Ltd. Name of the company.
clientLocation String 50 M clientLocation Location as registered by the client.
validTill String 10 M The date of expiry of the license. This can be a date in yyyy-mm-dd format or Unlimited. Unlimited means there is no expiry of the license.
baseURL String 250 M https://qm.api.codelayer.co.in this it the base url of the API.
status String 8 16 M Approved The description of the statusCode
features Array M List of additional features available with the license
id Integer 1 M 1 ID of the feature.
feature_name String 1 50 M Bill Cancellation Name of the feature.
description String M Allows to cancel existing bill. Description of the feature.
urls Array 1 M List of urls used in the feature.
name String 1 50 M Cancel Bill Name of the function
url String 1 250 M sales/cancel_bill The url for the function.
description String 250 M Cancel the bill. Description of the function.
license_key String 86 M ci8oYXcJgSDiCUvgVewjySW0N/IbJq4PJnmURf3Ve6LMjE4JyhadAZl7BYlUM77Vxds4hOUo3VhVZl4sHpIKHA The license key for the device. This key is needed for user login.

 

Sample Request
{
    "imei": "12345678901234",
    "appID": "QM_V3"
}
Sample Success Response
{
    "licenses": [
        {
            "statusCode": "2",
            "productName": "Quarry Manager - Version III",
            "clientName": "Codelayer Technologies Pvt. Ltd.",
            "clientLocation": "clientLocation",
            "validTill": "The date of expiry of the license.",
            "baseURL": "https://qm.api.codelayer.co.in",
            "status": "Approved",
            "features": [
                {
                    "id": "1",
                    "feature_name": "Bill Cancellation",
                    "description": "Allows to cancel existing bill.",
                    "urls": [
                        {
                            "name": "Cancel Bill",
                            "url": "sales/cancel_bill",
                            "description": "Cancel the bill."
                        }
                    ]
                }
            ],
            "license_key": "ci8oYXcJgSDiCUvgVewjySW0N/IbJq4PJnmURf3Ve6LMjE4JyhadAZl7BYlUM77Vxds4hOUo3VhVZl4sHpIKHA"
        }
    ],
    "e": 200,
    "msg": "Success"
}
Sample Failure Responses
{
    "e": 400,
    "msg": "Bad Request."
}