InnerWeb
Skip to main content

KD integration with work permits: recommendations for IT and security

Card swipes in an access control system can feed work permits and the attendance register without replacing cards or readers. Below are recommendations for IT and security: what to agree with the KD vendor, which fields to require, and how to design the connection so that it passes the firewall without opening inbound ports.

443
port of the HTTPS connection initiated by the plant
Source: karta
180 s
example duplicate threshold in the specification
Source: karta

For whom and why

These recommendations are for the IT and security teams of a plant that already runs an access control system and wants card swipes to stop ending up in a separate database. Once an event reaches the permit system, the fact of entry can be linked with authorisations, a valid training record and a permit for a specific job.

InnerWeb is a software producer, not a reader manufacturer. It does not replace the KD system: it receives events from it and adds a layer of permits, qualifications and attendance on top.

Recommendation 1: require an outbound connection

InnerWeb receives card swipe events as HTTPS messages initiated by the plant's site, on port 443. As a result, no inbound ports are opened into the plant's network, which simplifies the conversation with the cybersecurity team and usually shortens the time needed for approval.

Ask the KD vendor one thing: whether its system or its integration gateway can send HTTPS POST requests. This is one of three points to settle, alongside the list of entry and exit readers and the card export capability.

Example time windows in the integration specification

Example time windows in the integration specificationHorizontal bar chart: example duplicate threshold of 3 minutes, entry-exit pairing window of 780 minutes.0200400600800minDuplicate thresholdDuplicate threshold: 3 min3Entry-exit pairing windowEntry-exit pairing window: 780 min780
Source: Example parameters of the KD card swipe integration specification: 180 s and 13 h converted to minutes

Recommendation 2: fix the authentication up front

Authentication uses a technical account and a token with a limited validity period, renewed automatically by the integration. For the KD vendor this means the integrator must be able to obtain the token and renew it without human involvement. Agree who holds the technical account credentials and how they are stored, because this is part of your secrets policy.

Do not put account details into scripts that are copied between servers. Ask the vendor to describe how its system stores integration credentials and how it rotates them.

Recommendation 3: require a complete set of fields in each message

The KD system should send events in real time, and each swipe message should include the event time from the reader, the reader identifier, the person, the card number, the direction (entry or exit), and an event identifier. The reader's event time matters because it reflects the moment of the physical swipe, not the moment of sending after any network delay.

The event identifier ensures idempotency: if the same swipe is resent after a line failure, it will not create a duplicate entry. Without it, you have to rely on a time threshold, which is a weaker solution. The rules for discarding duplicates are set in the specification with the KD vendor.

  • event time from the reader
  • reader identifier
  • person and card number
  • direction (entry or exit)
  • event identifier for idempotency

Recommendation 4: set rules for readers without a direction

Not every reader distinguishes entry from exit. When a reader in the plant's KD system does not report a direction, the rules for pairing entries with exits and for discarding duplicates are set in the specification with the KD vendor, for example a window of up to 13 hours and a duplicate threshold of 180 seconds. The plant should check whether such parameters fit its shift patterns.

For three-shift work, a 13-hour window is enough for a full shift including a break, but not for long maintenance jobs. In that case, require the KD vendor to clearly mark exit readers.

Recommendation 5: prepare a reader list and a card export

The KD vendor should provide a list of readers marked as entry or exit, and an export of cards linked to people. The export allows you to match a card number with an account in the permit system.

Plan a time slot for the first data reconciliation. The biggest problem is usually inconsistent person records, for example a surname changed in one system but not in the other. It is worth deciding which system is the source of truth for people.

Recommendation 6: do not replace cards or readers for the integration

Integrating access control does not require replacing cards or readers. If someone proposes replacement as a condition, ask for the technical justification. If your cards are to be migrated for security reasons, that is a separate decision, unrelated to the integration with permits.

Keep the two projects apart: the integration of events and any possible modernisation of cards. The first one can be started quickly on the existing equipment.

Video

Frequently asked questions

What questions should we ask the KD vendor at the first meeting?

Three: whether the system can send HTTPS POST requests, which readers are entry and which are exit, and whether cards can be exported with their assignment to people.

Does the firewall need changes?

Usually not, because the connection is outbound on port 443. You only need to allow traffic to the specified address.

How is a duplicate swipe protected against?

The event identifier is meant to ensure idempotency, and the rules for discarding duplicates are set in the specification with the KD vendor.

Does integration mean buying new readers?

No. The integration does not require replacing cards or readers.

Let's prepare questions for your KD vendor

We will send you a one-page specification of swipe events to pass on to the vendor, and go through the answers with you.

Let's talk