For whom and when
This list is for the purchasing and IT team of a plant that has a working KD system and wants to add an OHS and working time module. InnerWeb is a software maker: it does not produce or replace readers, it integrates with the existing KD system as an independent supplementary system working alongside KD, RCP, HR and ERP.
The detailed specification for integrating the KD card system with RCP exists as a PDF document handed to the external vendor. The requirements below are its summary for the tender request.
Requirement 1: swipe delivery by HTTP POST webhook
The KD vendor should send an HTTP POST to InnerWeb with each card swipe. This is the simplest form of integration, because it requires no changes to the readers or the gates. The request should state that the vendor confirms this kind of sending is possible in the current software version, not only in a future one.
Rationale: InnerWeb provides an API and webhooks for integration with plant systems, so on the KD side it is enough to configure a single call.
Parameters to put into the request
Requirement 2: token authentication and its renewal
The call requires a token from the API login endpoint. The token has a limited validity period and is renewed automatically by the integration. The vendor should confirm that its software can renew the token automatically and retry rejected submissions.
If the KD software does not support such a login, the integration requires an intermediate layer, and its cost and time have to be priced into the offer.
Requirement 3: complete fields and unified spelling
The submission should contain the event time, the swipe location, first and last name, company name and the active card number, and optionally an acronym, phone, email and language. First and last name and company name are required.
State in the request that the company name comes from a single dictionary, because a swipe by a person unknown to the system creates an account and a company from the submission data, and different spellings produce duplicates.
Requirement 4: real-time sending
Requirement for the vendor: the KD system sends the event in real time, with the event time read from the reader, the direction (entry or exit) and the event identifier. After a line outage, the backlog of events is emptied within an agreed time, and the events keep their original times. It is worth recording the acceptable delay in minutes as an acceptance parameter.
Requirement 5: resilience to event bursts
In a plant with many staffing agencies, card traffic can exceed 2,000 swipes per working day. The vendor should document that its sending copes with bursts of events at the start of a shift and does not repeat submissions unnecessarily. Thanks to the event identifier, a retried send does not create a duplicate, and the detailed rules for rejecting duplicates are set in the specification with the KD vendor.
Requirement 6: list of swipe locations and an acceptance test
The vendor provides the full list of swipe location names (readers). Events from a location without a template in InnerWeb go to the log and do not trigger the training alert, so a complete list is a condition for effective control.
The acceptance test should cover a swipe by a known person, an unknown person and a person from an external company, at every location on the list.
Requirement 7: recording the limits in the contract
A webhook on its own, without mapping to entries and exits, does not give RCP: a swipe visible in the account history is not yet an entry in the gate register. The contract should therefore split the scope: what the KD vendor does (sending events with time, direction and identifier), and what is set up in InnerWeb (templates, pairing rules set in the specification, and the mRCP module switched on by the administrator).
Video
Frequently asked questions
Does InnerWeb supply card readers for the KD integration?
No. InnerWeb is a software maker and integrates with the readers the plant already has.
Does the webhook alone provide working time records?
No. The swipes need to be mapped to entries and exits, and the mRCP module has to be switched on by the administrator.
Who provides the integration specification?
InnerWeb passes the card-to-RCP integration specification document to the KD vendor.
Preparing a request to a KD vendor?
Get in touch with InnerWeb and we will provide the integration specification and help you word the requirements.
Let's talk