Activation code¶

Activation codes in Navixy streamline the device activation process by allowing users to set up devices themselves, ensuring they are configured with the appropriate plan and benefits from the start. These codes can include bonuses, free days, and monetary credits to a user’s balance upon activation, and are tied to specific plans.

Depending on the dealer's preference, activation codes can be optional or required. Dealers can choose to restrict device activation to only those they supply, preventing users from adding devices purchased elsewhere without an activation code received from the dealer.

Activation Code Object¶

Let's explore the Activation Code object using the example:

{
    "tariff_id": 12163,
    "bonus_amount": 0,
    "free_days": 14,
    "money_amount": 0,
    "device_type": "tracker",
    "code": "5248654776",
    "activated": false,
    "activation_date": null,
    "device_id": 0,
    "tariff_name": "Tracker demo plan"
}

• tariff_id - int. The ID of the plan.
• bonus_amount - int. The bonus amount that will be added to the user's balance when the device with this code is activated.
• free_days - int. The number of free days.
• money_amount - int. The amount of money that will be added to the user's balance.
• code - string. The code value.
• activated - boolean. Indicates whether the code is activated (true) or not.
• device_id - int. The ID of the device activated with this code. It will be 0 if the code is not activated yet.
• tariff_name - string. The name of the plan.

API actions¶

API base path: panel/dealer/activation_code.

create¶

Creates the specified number (count) of activation codes with the given tariff_id, bonus_amount, and free_days. Returns the count of created codes.

required permissions: activation_code: ["read", "create"].

Parameters¶

Examples¶

curl -X POST 'https://api.navixy.com/v2/panel/dealer/activation_code/create' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "fa7bf873fab9333144e171372a321b06", "count": 10, "tariff_id": 12457, "bonus_amount": 3, "free_days": 5}'

https://api.navixy.com/v2/panel/dealer/activation_code/create?hash=fa7bf873fab9333144e171372a321b06&count=10&tariff_id=12457&bonus_amount=3&free_days=5

Response¶

{
    "success": true,
    "count": 10
}

• count - int. Count of actually created codes.

Errors¶

• 201 - Not found in the database - when tariff with tariff_id not found for a current dealer.

list¶

Lists all dealer activation codes. If filter is used, entities will be returned only if filter string will contain one of the following fields: code, tariff_id, device_id, device_type.

required permissions: activation_code: "read".

Parameters¶

Examples¶

curl -X POST 'https://api.navixy.com/v2/panel/dealer/activation_code/list' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "fa7bf873fab9333144e171372a321b06"}'

https://api.navixy.com/v2/panel/dealer/activation_code/list?hash=fa7bf873fab9333144e171372a321b06

Response¶

{
    "success": true,
    "list": [{
         "tariff_id": 12163,
         "bonus_amount": 0,
         "free_days": 14,
         "money_amount": 0,
         "device_type": "tracker",
         "code": "1201245293",
         "activated": true,
         "activation_date": "2020-11-12 20:00:08",
         "device_id": 464606,
         "tariff_name": "Tracker demo tariff"
    }],
    "count" : 1
}

• list - array of objects. List of activation code objects.
• count - int. Total number of records (ignoring offset and limit).

update¶

Changes tariff_id, bonus_amount and free_days for all activation codes which: * has code listed in codes parameter. * belongs to a current dealer. * not activated yet. * belongs to the same device_type as a new tariff and return count of updated codes.

required permissions: activation_code: "update".

Parameters¶

Examples¶

curl -X POST 'https://api.navixy.com/v2/panel/dealer/activation_code/update' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "fa7bf873fab9333144e171372a321b06",  "codes": ["12315124", "12451576"], "tariff_id": 12457, "bonus_amount": 3, "free_days": 5}'

https://api.navixy.com/v2/panel/dealer/activation_code/update?hash=fa7bf873fab9333144e171372a321b06&codes=["12315124", "12451576"]&tariff_id=12457&bonus_amount=3&free_days=5

Response¶

{
    "success": true,
    "count": 5
}

• count - int. Count of actually updated codes.

Errors¶

• 201 - Not found in the database - when a plan with tariff_id is not found for the current dealer.