LogoLogo
IxkioLogin
  • Welcome
  • The Basics
    • Organisation / Structure
      • Folders
        • Organisational Folders
        • Active Folders
        • Active Folder Settings
      • Tag Groups
        • Tag Group Settings
      • Batches
        • Batch Settings
      • Tag Codes
        • Tag Code Settings
        • QR Codes
        • Using Authentication (NTAG424) NFC Tags
      • Moving Tag Codes
  • Response Modes
    • Response Modes Explained
    • API
      • Using the API Mode
      • API Mode for Authentication
    • Direct Response
    • Redirect
      • Using Redirect Mode
  • features
    • Rules
      • Creating a Rule
      • Rule Example
      • Rule Types
      • Rule Layering
    • Dynamic Response
      • Subtags
        • Subtags in API Extended Data
      • Datamerge
    • Data
      • Core Data
      • Extended Data
      • System Data
      • Action Data
    • Stats
    • Associate Data
    • Assignment
      • Scan Assignment
        • Scan Assignment with Ixkio Mobile App
        • Assignment Manager
      • Manual Assignment
  • Advanced Features
    • CodeLink
      • Using CodeLink
      • CodeLink Integration
      • Testing CodeLink
      • Integration Guides
        • Using CodeLink with Shopify
          • Shopify with Standard NFC Tags
          • Shopify with Standard Tags (Video)
        • Using CodeLink with Wix
    • Multiuser
    • Management API
    • Custom Domain
    • Clusters
    • SmartAccess
  • Mobile App
    • Ixkio Mobile Apps
    • Mobile App Functions
      • Check
      • Encode
        • API Response Mode Encoding
  • Account Management
    • Allowances & Usage
    • Additional Modules
    • Add-ons
    • Billing & Invoices
    • Account Information
    • User Settings
    • Cookies and Privacy
  • Explainers
    • Chip Count vs Scan Count
Powered by GitBook
On this page
  • Setting the Encode Domain
  • Encoding your Tags
Export as PDF
  1. Mobile App
  2. Mobile App Functions
  3. Encode

API Response Mode Encoding

If you are using the ixkio API Response mode for authentication, it's still possible to use the ixkio mobile app to encode your NTAG424 tags.

In this case, the tags will be encoded with your domain name to go to your server first. However, the keys will still be loaded into the ixkio platform against each tag.

API Response Encoding is designed for NTAG424 authentication tags only. If you are using the API Response Mode for regular NFC tags, then do not use this function (use the Seritag Encoder NFC app instead)

Setting the Encode Domain

Main Menu > Management > Advanced Settings > API Encoding Settings Panel

This field uses the subtags system to dynamically substitute tag data during encoding as follow :

Subtag
Data Substituted

{xuid}

Tag XUID

{cuid}

Tag CUID*

{count}

Tag Scan Count

{code}

NTAG424 CMAC Code

{uid}

Tag UID

At the moment, API encoding doesn't support PICCData (Encrypted UID and Counter mirror). We will be releasing this encoding option later in 2025.

CUID

The CUID Core Data field must be set on your console for each tag before you encode your tags. Encoding with the {cuid} subtag will take your Tag CUID and encode it permanently onto each tag. It's important to understand that if you then change the CUID in the console, the Tag encoding CUID will not dynamically change.

Encoding your Tags

You can now encode your Tags in the usual way with the App. Simply, create 'unencoded' Tag Codes within a Batch, enabled encoding from the 'Encode' Tab of the Batch Function panel. Tap the Encode Function on the App and encode.

Your NTAG424 Tag will be encoded with your URL, the encryption key will be automatically generated and stored against your Tag Code.

Encoding your Tags will lock them to the key. At the moment, the ixkio App cannot change the data encoded onto your NFC tags. We very strongly recommend encoding a couple of test tags before you encode any production tags.

Example

Assume that your landing page URL is :

https://authnfc.com/auth?tagid=abcd1234&count=000001&code=abcd1234abcd1234

Where you are taking the parameters of the tagid (in this case the xuid from ixkio), the count and the code to pass to our authentication API. You would enter into the console :

https://authnfc.com/auth?tagid={xuid}&count={count}&code={code}
PreviousEncodeNextAllowances & Usage

Last updated 3 months ago