The API page provides developers with access to the RedBeam RFID RESTful API, enabling seamless integration between RedBeam RFID and other systems using standard HTTP REST calls.
This page uses the Swagger (OpenAPI) specification to present interactive documentation. Swagger allows developers to explore endpoints, review parameters, and test requests directly from the browser.
If unfamiliar with Swagger, view an introduction here.
Developers can also generate client code in their preferred programming language to interact directly with the API.
Authentication
All API requests require a valid JWT (JSON Web Token) for authentication.
How to Obtain a JWT:
- Use the Security API (on this page) to log in and retrieve a token programmatically, or
- After logging in through the RedBeam web application, open your browser’s developer tools and copy the JWT from the request headers.
Include your token in the request header:
Authorization: Bearer YOUR_JWT_TOKEN_HERE
Note: Tokens are user-specific and time-limited. When a token expires, you must request a new one through the authentication endpoint.
