Sign in

Bulk import NFC transponders with .csv file

Eduard
  • Updated

For binding an NFC transponder to your locking system, you typically need to use an NFC-enabled device running the Tapkey App and present the NFC transponder physically. For individual large-volume orders, Tapkey offers the option to bulk-import NFC transponders using CSV files and registration codes, which removes the need of physical interaction with individual transponders.

 

Note: Only NFC transponders that come with registration codes can be bulk-imported. For security reasons, Tapkey NFC transponders usually come without registration codes. So for transponders that have not explicitly been ordered to come with registration codes, a bulk-import as outlined in this article, is not available.

 

Once a transponder has been imported via registration codes, it can be managed just like any other transponder

 

Note: Even though such transponders can be registered and managed without the need of physical interaction, it's still necessary to synchronize them after any modification in order for changes to take effect, which does require physical interaction. However, this synchronization can be done by anybody from anywhere and doesn't require special permissions.

 

This functionality is available only in the web browser.

 

Registering NFC transponders via a .csv file

As the scenario, where multiple cards must be registered one by one, might be tedious, we are providing an option to register them all at once using a comma-separated values file (.csv). 

 

The file has the following properties:

  • The file must be semicolon delimited.
  • The first line of the file must contain the column names.
  • The following properties (columns) are considered:
    • <NFC transponder ID> (required): described in more detail below
    • bindingCode (required) - the registration code
    • title (optional) - title or name of the NFC transponder in the locking system
    • description (optional) - description of the NFC transponder
  • One of the following NFC transponder ID types must be specified in the file:
    • provisioningIdHex - the card ID; E.g. for a card labeled 'M-AB-1234-5678' this would be 'AB12345678'. This is the suggested type of ID to be specified.
    • label - the label printed onto the card, e.g. 'M-AB-1234-5678'.
  • Only one ID-type column is allowed (i.e. either 'provisioningIdHex' or 'label').
  • Any unknown column will be ignored.
  • Quoting and escaping applies according to RFC 4180.

 

Example of an import file:

label;bindingCode;title
M-01-1234-ABCD;1234-abcd;My Card #1
M-02-ABCD-1234;abcd-1234;My Card #2
M-03-ABCD-1234;abcd-1234;"Escaped;value"
M-04-ABCD-1234;abcd-1234;"""Escaped;value"""
  • "Escaped;value" will be decoded to Escaped;value
  • """Escaped;value"""will be decoded to "Escaped;value"

 

1. Once you have your file ready, follow these steps to perform the import (only available in the browser):

  • Navigate to the Tapkey Web Portal.
  • After successfully logging in, select your locking system.
  • Navigate to NFC Transponders.
  • Click Bulk Import button in right upper corner.

Bulk Import.png

2. In the new pop-up choose a file from your disk drive and click Import.

Optional: If you have the same registration code for all the NFC transponders, you can check Use the same registration code for all imported NFC transponders (6) and type it into the text field that will appear after. Please note, that only one appearance of registration code is allowed, either in the dialog or in the file.

Bulk Import (2).png

 

3. Wait for the import to finish

When the import is finished, download the report (8) and close the dialog (9).

Bulk Import (3).png

Check the report to see the individual import results.

 

Report

 The report file is the same .csv file that you have provided, but with two additional columns: Result, Details and Timestamp.

In the Result column you can see if the import of the corresponding NFC transponder was successful (Success), failed (Error) or skipped (Skipped). As the name suggests, the Details column contains detailed information about the particular issue, if there were any.

Possible outcomes:

  • Success: The transponder has been imported.
  • Skipped: The transponder has already been imported to the same owner account before, so no action was taken.
  • Error: The transponder could not be imported. Refer to the Details column for more information.

Example of a report file:

label;bindingCode;title;Result;Details;Timestamp
M-01-1234-ABCD;1234-abcd;My Card #1;Success;;2022-09-16 13:57:29
M-02-ABCD-1234;abcd-1234;My Card #2;Skipped;already bound to this owner account;2022-09-16 13:57:29
M-03-ABCD-1234;abcd-1234;"Escaped;value";Error;Reg code not found.;2022-09-16 13:57:30
M-04-ABCD-1234;abcd-1234;"""Escaped;value""";Success;;2022-09-16 13:57:30

Related articles