Page Comparison

Our Licensing APIs are designed to interact with the Members Account licensing system allowing you to get, activate, and transfer Iguana licenses programmatically, providing you have access and licenses available to do so.

License Activation

The following steps provide an example license activation workflow calling the Iguana license APIs using curl commands:

1. Get the Iguana ID of your target Iguana instance

There are two methods which can be used to obtain the Iguana ID:

Expand
title Option A: Use the iguana --id command line flag (requires IguanaX v10.1.101)
The Iguana ID can be obtained using the command line --id flag. If you need to target a unique working directory, you can optionally use --id --working_dir <working_directory> to point to a specific Iguana working directory and return the Iguana ID. Windows: Code Block iguana --id --working_dir "C:\ProgramData\IguanaX" Image Removed Linux: Code Block ./iguana --id *optionally add the --working_dir flag

...

Use your Iguana instance IP address and port: https://127.0.0.1:7654

1. Authenticate GET /session/login

To call the IguanaX APIs you must first login and get a session cookie from the response header to authenticate your subsequent requests.

Parameters:

• username: Your IguanaX instance username string

• password: Your IguanaX instance password string

Response Header:

Content-Length: 128
Set-Cookie: IguanaSession-jYQGeQWk97ylKuP8AmEiad=z7WR4Xwzk51hXMP2e3WeZa; path=/; HttpOnly; SameSite=Strict

Example curl command calling the /session/login API and parsing to retrieve Iguana session cookie the response header Set-Cookie to authenticate the next API call:

Should look similar to: IguanaSession-jYQGeQWk97ylKuP8AmEiad=z7WR4Xwzk51hXMP2e3WeZa

IguanaCookie=`curl -i -k -X GET "http://127.0.0.1:7654/session/login?username=<user>&password=<pass>" | grep -i 'Set-Cookie: ' | awk '{print $2}' | sed 's/;$//'`

2. Get License details POST /license/get

This API method returns a JSON object containing the Iguana ID along with other license information. To authenticate, the obtained Cookie is provided in the header of the request.

Response:

{
    "data": {
        "iguana_id": "THSWPRHMUXTT7MRR",
        "license": {
            "component_limit": 500,
            "expiry": "0",
            "license_status": "License ok",
            "message_rate_limit": 0,
            "search_limit": 365
        },
        "license_message": "To modify or extend your license, contact the iNTERFACEWARE Sales Office."
    },
    "success": true
}

Example curl command calling the /license/get API and parsing to retrieve the Iguana ID:

IguanaID=`curl -k --header "Cookie: $IguanaCookie" -X POST "http://127.0.0.1:7654/license/get" | jq -r '.data.iguana_id'`

2. Call the Members Account Licensing APIs to register your Iguana ID to generate a license code

{
    "data": {
        "Token": "277DBB66C802BE3287207FFE120595EC",
        "Info": {
            "Permissions": {
                "LicenseTransfer": true,
                "TemporaryLicense": true,
                "LicenseRead": true,
                "FinancialRead": false,
                "LicenseWrite": true
            },
            "CompanyName": "Richard Wang - Client "
        }
    },
    "status": "ok"
}

IguanaToken=`curl -k -X POST "https://my.interfaceware.com/api?username=<InterfacewareUser>&password=<InterfacewarePassword>&method=session.login" | jq -r '.data.Token'`

{
    "data": [
        {
            "entitlements_total": "3",
            "name": "IguanaX Dev",
            "num_components": "50",
            "id": "1",
            "entitlements_used": "1",
            "license_expiry": "0",
            "log_search": "365"
        },
        {
            "entitlements_total": "3",
            "name": "IguanaX Test",
            "num_components": "50",
            "id": "2",
            "entitlements_used": "1",
            "license_expiry": "0",
            "log_search": "365"
        },
        {
            "entitlements_total": "3",
            "name": "Iguana X Prod",
            "num_components": "50",
            "id": "3",
            "entitlements_used": "1",
            "license_expiry": "0",
            "log_search": "365"
        },
    ],
    "status": "ok"
}

LicenseName="IguanaX Test" #change to name of license type to activate
EntitlementID=`curl -k -X POST "https://my.interfaceware.com/api?method=license.listentitlements&product=IguanaX&token=<IguanaToken>" | jq -r --arg name "$LicenseName" '.data[] | select(.name==$name) | .id'`

...

Members Account Licensing API base URL: https://my.interfaceware.com

...

This API method returns a JSON object containing the license description and activated license code.

Parameters:

• product: The product you want licenses for - IguanaX string

• token: Your authentication token string (from the first call)

• method: The API method license.activate string

• description: A description to pair with the license (test, prod, etc.) string

• entitlementid: The ID of the license you want to activate string

• instanceid: The Iguana ID of the instance that you want to apply the license to string

Response:

{
    "data": {
        "description": "Test",
        "code": "4492A1B5CDA25D79DFCC5DC3GHS4448B9D8A3CCC98",
        "license_expiry": "2025-08-13",
        "name": "IguanaX Test",
        "instanceid": "THSWPRHMUXTT7MRR",
        "log_search": 365,
        "num_components": 50
    },
    "status": "ok"

Example curl command calling the API and parsing the license code from the response:

IguanaLicenseCode=`curl -k -X POST "https://my.interfaceware.com/api?method=license.activate&product=IguanaX&token=<IguanaToken>&description=IguanaLicense&entitlementid=<EntitlementID>&instanceid=<IguanaID>" | jq -r '.data.code'`

3. Apply the license code to the new Iguana instance

There are two possible methods to apply the generated license code to the new Iguana instance:

echo $IguanaLicenseCode > C:\ProgramData\IguanaX\IguanaLicense;

echo $IguanaLicenseCode > /home/iguanauser/.IguanaX/IguanaLicense;

...

Use your Iguana instance IP address and port: https://127.0.0.1:7654

1. Authenticate GET /session/login

To call the IguanaX APIs you must first login and get a session cookie from the response header to authenticate your subsequent requests.

Parameters:

• username: Your IguanaX instance username string

• password: Your IguanaX instance password string

Response Header:

Content-Length: 128
Set-Cookie: IguanaSession-jYQGeQWk97ylKuP8AmEiad=z7WR4Xwzk51hXMP2e3WeZa; path=/; HttpOnly; SameSite=Strict

Example curl command calling the /session/login API and parsing to retrieve Iguana session cookie the response header Set-Cookie to authenticate the next API call:

Should look similar to: IguanaSession-jYQGeQWk97ylKuP8AmEiad=z7WR4Xwzk51hXMP2e3WeZa

IguanaCookie=`curl -i -k -X GET "http://127.0.0.1:7654/session/login?username=<user>&password=<pass>" | grep -i 'Set-Cookie: ' | awk '{print $2}' | sed 's/;$//'`

2. Apply the license codePOST /license/set

This API method applies the registered license code to the Iguana instance and returns a JSON object containing the request success or failure. To authenticate, the obtained Cookie is provided in the header of the request.

Parameters:

• license: the license code to be applied string

Response:

{
    "data": {},
    "success": true
}

Example curl command calling the /license/set API to apply the license code and activate the Iguana instance:

IguanaID=`curl -k --header "Cookie: $IguanaCookie" -X POST "http://127.0.0.1:7654/license/set?license=<LicenseCode>"

License Transfer

...

Gain access to the Iguana ID used to transfer to.

...

Obtain Authentication Token.

...

Gain Access to the Entitlement ID.

...

Gain access to the Activation ID of the current Iguana Instance.

...

Gain access to the new code and transfer the new Iguana Instance.

...

• Automating License Activation

• Automating License Transfers