RUFUS Help
RUFUS Cloud Public API
RUFUS Cloud Public API
  • Introduction to RUFUS Cloud API
  • Getting Started
    • Overview
    • Get your api keys
    • Api permissions
  • TIMING DEVICES
    • Overview
    • Bind a new device
    • Unbind a device
    • Get devices by company
    • Get device information
  • TIMING SESSIONS
    • Overview
    • Insert a new session
    • Close a session
    • Get sessions by device
    • Get active session from device
    • Get session information
  • RACE PASSINGS
    • Overview
    • Insert passings
    • Get session passings by range
    • Get device passings by datetime
Powered by GitBook
On this page
  1. Getting Started

Api permissions

You api keys can have different access types.

You can choose different access types to your api keys, giving each application only the access they need to perform the specific required operations.

Access type
Permissions

READ

Has permission to call all GET methods. Can read devices, sessions and passings information.

WRITE

Has permission to call all POST and PATCH methods. Can bind devices, insert sessions and passings.

READ_WRITE

Has permission to call all methods.

Unbind device

Property only available for WRITE and READ_WRITE api keys. Has permission to call the DELETE method and allows a device to be deleted from an account.

Typical use case could be:

Api key alias
Access type
Application

Devices

WRITE

Api key to use in my custom RFID timing devices.

Timing app

READ_WRITE

Api key to use in my timing software or manual timing app.

Classification app

READ

Api key to use in my own classification software or application.

Admin

READ_WRITE Unbind = true

Api key to use in my timing administration dashboard.

PreviousGet your api keysNextOverview

Last updated 2 years ago