| Section | Description |
|---|---|
| Project Description | Overview of the project and its features |
| Technologies Used | List of technologies utilized in the project |
| Features | Functionalities provided by the system |
| API Requests | API endpoint details for IMEI checking |
| How to Run the Project | Steps to set up and run the project |
| Testing | Instructions for running tests and linting |
| Project Structure | Folder structure explanation |
| Usage Presentation | Presentation of bot and API usage |
| Contacts | Developer contact information |
This project is a backend system built with FastAPI, integrated with a Telegram bot (aiogram), designed for checking IMEI numbers of devices.
The system allows:
- 🌟 Checking IMEI numbers via a Telegram bot.
- 🔑 Restricting access via a whitelist of authorized users.
- 🔒 Authenticating API requests using tokens.
- 🛠️ Using PostgreSQL for data storage and Redis for caching.
- 🐳 Running with Docker & docker-compose.
- ✅ Testing with Pytest, Tox and linting with Ruff.
- Backend:
- Database:
- Cache & Messaging:
- Telegram Bot:
- Testing & CI/CD:
- Deployment:
- ✅ Whitelist for Telegram users – Only approved users can interact with the bot.
- ✅ Token-based API authentication – Only authorized requests can access the system.
- 🎡 User sends an IMEI number to the bot.
- 🛡️ The bot validates the IMEI.
- 📊 The bot returns device information.
🔹 Request Parameters:
{
"imei": "123456789012345",
"token": "your_auth_token"
}🔹 Response Example:
{
"id": "QlMEbz_nPPy4JkzW",
"type": "api",
"status": "successful",
"orderId": null,
"service": {
"id": 12,
"title": "Mock service with only successful results"
},
"amount": "0.00",
"deviceId": "860479069365109",
"processedAt": 1738168765,
"properties": {
"deviceName": "iPhone 13 Pro Max 256GB Gold [A2484] [iPhone14,3]",
"image": "https://sources.imeicheck.net/images/5f8fce1d71ce09f9c773a51568971316.png",
"imei": "860479069365109",
"meid": "86047906936510",
"imei2": "566392068297521",
"serial": "OA1TPDDDVAXAF",
"estPurchaseDate": 1712368292,
"additional_data": {
"replaced": false,
"repairCoverage": false,
"technicalSupport": false,
"modelDesc": "SVC IPHONE 11 PRO MAX NA 64G GRY CI/AR",
"replacement": false,
"refurbished": false,
"apple/modelName": "iPhone 13 Pro Max",
"fmiOn": false,
"lostMode": true,
"usaBlockStatus": "Reported stolen by AT&T MOBILITY"
}
}
}📌 API uses the service imeicheck.net.
🛠️ Sandbox API Token: e4oEaZY1Kom5OXzybETkMlwjOCy3i8GSCGTHzWrhd4dc563b
git clone https://github.com/arielen/test_Hatiko_tech.git
cd test_Hatiko_techCreate an .env file based on .env.example:
cp .env.example .envFill in environment variables (PostgreSQL, Redis, API Token, etc.).
docker-compose up --build👉 The project will start in containers:
FastAPIathttp://localhost:8000PostgreSQLatlocalhost:5432Redisatlocalhost:6379
tox # for run all tests
# tox -e lint # for check lint and codestyle
# tox -e py313 # for run testspytest testsruff check .📂 imei-bot/
├── 📂 bot/ # TG Bot
│ ├── 📂 database/ # Database models and queries
│ ├── 📂 enums/ # Enum definitions for bot settings
│ ├── 📂 handlers/ # Handlers for bot commands and callbacks
│ ├── 📂 keyboards/ # Keyboard markup configurations for bot UI
│ ├── 📂 locales/ # Localization files for multi-language support
│ ├── bot.py # Main bot initialization and event loop
│ ├── config.py # Bot configuration and settings
│ ├── signals.py # Signal handling for bot events
├── 📂 src/ # API
│ ├── 📂 api/ # FastAPI endpoints
│ ├── 📂 core/ # Configuration
│ ├── 📂 schemas/ # Pydantic schemas
│ ├── 📂 services/ # IMEI checking logic
│ ├── main.py # FastAPI entry point
├── 📂 tests/ # Pytest tests
├── .env.example # Example environment variables
├── docker-compose.yml # Docker Compose configuration
├── Dockerfile.api # Dockerfile for run API
├── Dockerfile.bot # Dockerfile for run TG Bot
├── pyproject.toml # Configuration for ruff & pytest
├── tox.ini # Tox configuration
├── requirements-api.txt # Python dependencies API
├── requirements-bot.txt # Python dependencies TG Bot
├── requirements-test.txt # Python dependencies for tests
├── README.md # Project documentation
bot_present.mp4
api_present.mp4
💻 Developer: arielen
📧 Email: pavlov_zv@mail.ru
📧 TG: 1 0