https://github.com/soulee-dev/pykipass
📱사장님들을 위한 QR체크인, 전자출입명부, KIPass API 파이썬 라이브러리 - 통계, QR체크인, 오버레이 제공
https://github.com/soulee-dev/pykipass
kipass korean python python3 qrcheckin qrcode
Last synced: 30 days ago
JSON representation
📱사장님들을 위한 QR체크인, 전자출입명부, KIPass API 파이썬 라이브러리 - 통계, QR체크인, 오버레이 제공
- Host: GitHub
- URL: https://github.com/soulee-dev/pykipass
- Owner: soulee-dev
- License: other
- Created: 2022-01-10T17:19:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-28T02:03:40.000Z (over 3 years ago)
- Last Synced: 2025-03-12T23:13:22.275Z (about 2 months ago)
- Topics: kipass, korean, python, python3, qrcheckin, qrcode
- Language: Python
- Homepage:
- Size: 10.1 MB
- Stars: 29
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
사장님용 QR체크인, 전자출입명부를 위한 파이썬 API Wrapper
QR체크인도 할수 있어요!
QR체크인 API를 이용한 현 시각 기준 손님수 예측 오버레이
현재시각 기준 손님수 / 지난 데이터 기준 예측 손님수
QR체크인 API를 이용한 특정 가계의 손님 수 통계
요일별 손님수
시간대별 손님수
## Legal Disclaimer
**서비스에 무리가 갈정도로 요청하지 마세요.**
**Do not send request over a short span.**
비상업적 용도만 사용 가능. 오직 교육적 목적으로만 사용할수 있으며, 전자출입명부(KIPass)는 질병관리청의 자산입니다. 악의적 공격에 이용할시 처벌 받을수 있습니다. 사용에 따른 책임은 사용자가 집니다.
Non Commercial Only. Only use for educational purposes, KIPass is asset of MOHW. User takes responsibility for usage.
## Install
```
pip install PyKIPass
```
## Using
### Import
```python
> from PyKIPass import *
```
### Login
```python
> kipass = KIPass(username="USERNAME", password="PASSWORD")
```
#### Security Considerations
아이디, 비밀번호는 환경변수를 이용해 저장하는것이 보안상 좋습니다.
```python
> import os
> kipass = KIPass(username=os.environ.get("KI_PASS_ID"), password=os.environ.get("KI_PASS_PASSWORD"))
```
### 특정 날짜의 고객수 불러오기
```python
> kipass.get_customer_count_on_day(date="20220107")
CustomerCountOnDay()
```
### 2주간 기간의 고객수 불러오기
```python
> kipass.get_customer_count_on_two_week(start_date="20211219", end_date="20220102")
CustomerCountOnTwoWeek[]
```
### QR코드 인증하기
```python
> kipass.verify_qr(parsed_qr_code="....")
VerifyQR
```
## Examples
[Graphing](/examples/customer%20pass%20graph)
[Overlay](/examples/customer%20pass%20overlay)
## Objects
### User
```python
> kipass.user.[parameter]
```
- boss_name
- is_enabled
- address_detail
- is_transferred
- is_async
- version
- is_boss
- biz_no_count
- authed_phone_number
- phone_number
- business_register_number
- username
- os_type
- business_name
- new_terms_yn
- name
- str_use_yn
- process_type
- business_id
- address
- uuid
- business_type
### CustomerCountOnDay
- total_customer_count
- vaccinated_customer_count
- fully_vaccinated_customer_count
- dates
- time
### CustomerCountOnTwoWeek
- total_customer_count
- vaccinated_customer_count
- fully_vaccinated_customer_count
- dates
### VerifyQR
- voice
- msg
- vaccine_type
- vaccine_code
- background_color
- success