API

Designed for for verification of authentication tags, ixkio's Response API access is available on Flex API, or on other plans with the Extra Response Mode module.

Use of the API system requires a strong understanding of technical knowledge and the ability to access and develop your webserver at an in-depth level. Ixkio cannot give advice on setting up or the configuration of your server beyond advising how our server would respond to an API call. If you aren't technically minded or don't have access to technical developers, we'd recommend using our Redirect Response Mode instead.

These pages details how to use the Response API and how to access the API to verify your tag scans.

If you are looking to use the Management API to modify Tag Codes, then read about Management API.

Typical Use Case

In all cases, the authentication NFC tag will link directly to your webserver or application, rather than linking directly to the ixkio platform. In other words, you can't use ixkio as a redirect and API platform for the same tag.

Where the tags are linked to a website, your webserver would extract the query string parameters from the URL and then make a GET request with those parameters to our server. The ixkio server will check the parameters and respond with a pass or fail message.

Your server can then respond directly to the user with the appropriate message.

API Overview

The ixkio Response API system is designed to be easy to use and access.

• The Response Mode API can only be used to extract tag information, not set, create or change it

• Rules can be used to control the API response

• API responses can also include Dynamic Response information

• All API requests must be on https not http

• Access to API can be open or controlled with an API Key