Readers

Sign in as a PassEntry Reader using its Reader ID and password, exactly as the PassEntry Reader app does. Returns a session token, a refresh token and the reader's NFC configuration. A reader holds one session at a time: logging in again invalidates the previous session's tokens. Keep the session alive with Reader heartbeat every 5 minutes.

post/api/v1/readers/login

Request

  • Base URL
    https://api.passentry.com
  • URL
    https://api.passentry.com/api/v1/readers/login
  • Auth
    none required

Request body

Response

Successful

Example response

{
  "data": {
    "type": "reader",
    "attributes": {
      "name": "South Entrance Reader 1",
      "id": "south_entrance_01"
    }
  }
}

Changes