API¶

• API
• Plans
• list
• show
• generated_licenses
• generate
• Licenses
• show
• download

Plans¶

list¶

Lists users plans

Parameters:

none

Example

curl -u "user:pass" https://crm.innovatrics.com/api/license/list.xml

will give a response in format:

<?xml version="1.0" encoding="UTF-8"?>
<license-rights type="array">
  <license-right>
    <id type="integer">1</id>
    <name>IDKit PC Royalty Free</name>    
    <used-license-count type="integer">10</used-license-count> 
    <total-license-count type="integer">100</total-license-count>
    <user-records type="integer">50000</user-records>
    <note>Test Plan</note>
  </license-right>
  <license-right>
    <id type="integer">2</id>
    <name>ANSI &amp; ISO Mobile Package 10</name>
    <user-records type="integer">1</user-records>
    <used-license-count type="integer">1</used-license-count> 
    <total-license-count type="integer">10</total-license-count>
    <note>Test Plan2</note>
  </license-right>
</license-rights>

show¶

Shows attributes of users plan. User must be owner of this plan, otherwise throws an error

Parameters

• id: id of plan

Example

curl -u "user:pass" https://crm.innovatrics.com/api/license/show/7.xml

Result should be

<license-right>
  <id type="integer">7</id>
  <total-license-count type="integer" nil="true"></total-license-count>
  <user-records type="integer">50000</user-records>
  <name>IDKit PC Royalty Free</name>
  <used-license-count type="integer">16</used-license-count>
  <note>Test Plan</note>
</license-right>

generated_licenses¶

List already generated licenses and their attributes

Parameters

• id: id of a plan

Example

curl -u "user:pass" https://crm.innovatrics.com/api/license/generated_licenses/7.xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<generated-licenses type="array">
  <generated-license>
    <hwid nil="true"></hwid>
    <id type="integer">4</id>
    <valid-until type="date" nil="true"></valid-until>
    <note>Test License</note>
  </generated-license>
  ...
</generated-license>

generate¶

Generates a license from a plan. For downloading the license use generated_license/download

Parameters:

• id: id of a plan
• hwid: hardware id of the machine the key is generated for
• note: note for a license

Returns

• id: id of generated license
• license-key: license key in Base64 format

Example

curl -u "user:pass" "https://crm.innovatrics.com/api/license/generate/7.xml?hw_id=HWID123456&note=Test%20License"

Response

<?xml version="1.0" encoding="UTF-8"?>
<generated-license>
  <hwid>HWID123456</hwid>
  <id type="integer">2041</id>
  <valid-until type="date" nil="true"></valid-until>
  <license-key>SUNfTAMARAAAAAAAAABIV0lEMTIzNDU2AAAAAAAAAAAAAGNsaWVudAAAAAAA...5gsjc7A==</license-key>
  <note>Test License</note>
</generated-license>

Licenses¶

show¶

Parameters

• id: id of license (fe. obtained via license/generated_licenses)

Example

curl -u "user/token:821319312873812421" https://crm.innovatrics.com/api/generated_license/show/2041.xml

Response

<?xml version="1.0" encoding="UTF-8"?>
<generated-license>
  <hwid>123</hwid>
  <id type="integer">2041</id>
  <license-key>SUNfTAMARAAAAAAAAABIV0lEMTIzNDU2AAAAAAAAAAAAAGNsaWVudAAAAAAA...5gsjc7A==</license-key>
  <valid-until type="date" nil="true"></valid-until>
  <note>Test License</note>
</generated-license>

download¶

parameters

• id: id of license

Example

curl -u "user/token:821319312873812421" https://crm.innovatrics.com/api/generated_license/download/7 > iengine.lic

Response

Unlike other API calls, this methods returns the iengine.lic file instead of XML.