Management API

Flex Alpha

These Management API documents details how to use the ixkio API to change Tag Code Status, Assignment, NFT Data and Default Response.

The Management API is different than the standard Response API.

If you are using ixkio in API Response Mode to authenticate tags, then instructions and information can be found on the API Response Mode pages. The Response API simply allows the check of Tag Code data and is typically used for authentication of an NFC Tag. The Response API is available on both the Flex Pro and Alpha plans. The Management API allows remote changes to the Tag Code data and is only available on the Flex Alpha plan.

Using Management API

The Management API system can currently be used to remotely modify a Tag Code's status and/or a Tag Code's Default Response. The Tag Code must have already been created in the Console.

Tag Code Status for any of the Response Modes (Redirect, API or Direct Response) can be changed to either Active or Inactive. Default Response can be modified for either the Redirect or API Response Modes.

To use the Management API, you need to set an API Token at Main Menu > Management > Advanced Settings > Management API Settings Panel.

The Token needs to be sent in the PATCH header as X-API-Key, X-Api-Key or Ixkio-R

Accessing the Management API

The ixkio API Management endpoint is located at :

PATCH https://api.ixkio.com/v1

All requests must be over HTTPS

You can access the Tag Code by using either the XUID or your AID along with a CUID or UID of the Tag Code with a PATCH request as follows :

XUID

Example : PATCH https://api.ixkio.com/v1/x/{xuid}

CUID or UID

Example : PATCH https://api.ixkio.com/v1/a/{aid}

along with your CUID or UID in the PATCH request HEADERS, for example :

ix_c: {cuid}

or

ix_u: {uid}

The CUID parameter is case sensitive search - ABC123 is not the same CUID as abc123. The UID parameter must always be uppercase.

Parameters

The management API accepts the following parameters :

ix_dr

Options : URL (redirect mode), Response (API mode) or empty.

Action : Updates the Default Response for a Tag Code. If Tag Code is inheriting Response from the Tag Group, it will break the link and set the Response. If the parameter is empty, it will remove the Response and Revert the Ruleset to the Tag Group level.

Example 1 :

'ix_dr' => ''

This will remove any Tag Code response and Revert the Ruleset to the Tag Group level.

Example 2 :

'ix_dr' => 'https://seritag.com'

This will set the Response for the Tag Code to https://seritag.com

ix_status

Options : Active, Inactive

Action : Will change the Status of the Tag Code to either Active or Inactive.

ix_assigned

Options : Assigned, Unassigned

Action : Will change the Status of the Tag Code to Assigned or Unassigned. If set to Assigned, the Assigned Date field will be updated.

ix_nftchain

Options : etherium_main, etherium_test, polygon_main, polygon_test, empty

Action : Will set the nft blockchain for the Tag Code.

ix_nftcontract

Options : NFT Contract Address, empty

Action : Will set the NFT Contract Address associated with a Tag Code

ix_nfttoken

Options : NFT Token Address, emtpy

Action : Will set the NFT Token Address associated with a Tag Code

To set NFT data, you must include all fields ix_nftchain, ix_nftcontract and ix_nfttoken.

If you include the fields then all must have data or all must have no data (to remove NFT data).

ix_nftowner

Options : NFT Wallet Owner Address. empty

Action : Will update the Owner Address associated with a Tag Code

This field can be included alongside the other NFT data fields or can be included on it's own (or with status, assigned fields, etc).

API Response

The API will respond 200 OK with either the following JSON :

{
    "xuid":"<<yourxuid>>",
    "status":"success"
}

or an error message in the format :

{
    "xuid":"<<yourxuid>>",
    "status":"error",
    "error":
    {
        "type":"MgmtAPIError",
        "message":"Invalid Status",
        "code":"e44328",
        "detail":""
    }
}