Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

KISI Readers API

The Readers API from KISI — 6 operation(s) for readers.

KISI Readers API is one of 48 APIs that KISI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Readers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 7 operations across 6 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.kisi.io.

7 operations 6 paths 2 schemas 2 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.kisi.io
Authentication
API Key, API Key, API Key, API Key, API Key, HTTP Basic, OAuth 2.0
Resource Areas
1

Authentication & Security 7

KISI Readers API declares 7 security schemes for authenticating requests. An API key is passed in the header as X-Signature (Webhook-Signature). An API key is passed in the header as Authorization (Kisi-Login). An API key is passed in the header as Authorization (Kisi-Access-Key). An API key is passed in the header as Authorization (Kisi-Group-Link). An API key is passed in the header as Authorization (Kisi-Service). It accepts HTTP basic authentication (OAuth2Basic). It supports OAuth 2.0 (OAuth2) using the authorizationCode flow.

  • Webhook-Signature — Authorize using a signature of the request body. The signature is a HMAC-SHA256 hash of the request body using a secret key. E.g. X-Signature: 123
  • Kisi-Login — Authorize using a login. Prefix the value with KISI-LOGIN Example: Authorization: KISI-LOGIN 123
  • Kisi-Access-Key — Authorize using an access key. Prefix the value with KISI-ACCESS-KEY Example: Authorization: KISI-ACCESS-KEY 123
  • Kisi-Group-Link — Authorize using a group link. Prefix the value with KISI-GROUP-LINK Example: Authorization: KISI-GROUP-LINK 123
  • Kisi-Service — Authorize using a service. Prefix the value with KISI-SERVICE Example: Authorization: KISI-SERVICE 123
  • OAuth2Basic — Username is the client id. Password is the client secret.
  • OAuth2 — OAuth access tokens are sent as bearer tokens. Example: Authorization: Bearer youraccesstoken

Paths & Operations 7

Across 6 paths, the API surfaces 7 operations — 2 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Readers 7
GET
/readers
Fetch readers
fetchReaders 9 params → 200401
POST
/readers/{token}/assign
Assign a reader by token
assignReader 1 param body → 204401403404422
POST
/readers/{id}/deassign
Deassign a reader
deassignReader 1 param → 204401403404
POST
/readers/{id}/reset_tamper
Reset the tampered state of a reader
resetTamperedState 1 param → 204401403404409
POST
/readers/{id}/reboot
Reboot a reader
rebootReader 1 param → 204401403404
GET
/readers/{id}
Fetch reader
fetchReader 1 param → 200401403404
PATCH
/readers/{id}
Update reader
updateReader 1 param body → 204401403404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Error (2 properties), Errors (1 property). Each schema is shown below with its type and property counts.

Errors
object
Schema describing validation errors.
1 property 1 required
Error
object
Schema describing errors.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kisi-readers-api-openapi.yml Raw ↑

Other APIs KISI publishes across the network.

KISI Calendars API
KISI Cameras API
KISI Card assignments API
KISI Cards API
KISI Controller Input Connections API
KISI Controller Inputs API
KISI Controller Relay Connections API
KISI Controller Relays API
KISI Controller Wiegand Connections API
KISI Controller Wiegands API
KISI Controllers API
KISI CSV card imports API