https://github.com/icarogabryel/rest-rfid-authorization
Simple RESTful API for managing RFID card authorization to study single app minimalist Django project structure.
https://github.com/icarogabryel/rest-rfid-authorization
django django-rest-framework rest-api rfid webapp
Last synced: about 1 month ago
JSON representation
Simple RESTful API for managing RFID card authorization to study single app minimalist Django project structure.
- Host: GitHub
- URL: https://github.com/icarogabryel/rest-rfid-authorization
- Owner: icarogabryel
- License: mit
- Created: 2025-09-17T05:27:41.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-09-18T01:11:55.000Z (9 months ago)
- Last Synced: 2025-10-06T20:59:37.513Z (9 months ago)
- Topics: django, django-rest-framework, rest-api, rfid, webapp
- Language: Python
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 🪪 RFID Authorization REST API
This is a simple RESTful API for managing RFID card authorization to study single app minimalist Django project structure.
## 🧩 Business Rules
Each RFID card registered in the system has an access level. The embedded systems will be the edge nodes and each will have inside their firmware the minimum access level required to enter a specific area. The edge nodes can retrieve a specific card to check its access level, create a new card, update the access level of an existing card or delete a card.
## 🚪 Access Levels
The access levels are like the Resident Evil 2 video game, where the player can find different access electronic chips to open doors with different colors. The access levels are:
- GREEN: can open GREEN doors
- BLUE: can open GREEN and BLUE doors
- PURPLE: can open GREEN, BLUE and PURPLE doors
## 🌐 API Endpoints
- Create Card
- Path: `/card/`
- Method: `POST`
- Request body:
```json
{
"id": "string",
"access_level": "string",
}
```
- Response code: 201 Created
- Response body:
```json
{
"id": "string",
"access_level": "string",
}
```
- Retrieve Card
- Path: `/card/{id}/`
- Method: `GET`
- Response code: 200 OK
- Response body:
```json
{
"id": "string",
"access_level": "string",
}
```
- Update Card
- Path: `/card/{id}/`
- Method: `PUT`
- Request body:
```json
{
"access_level": "string",
}
```
- Response code: 200 OK
- Response body:
```json
{
"id": "string",
"access_level": "string",
}
```
- Destroy Card
- Path: `/card/{id}/`
- Method: `DELETE`
- Response code: 204 No Content