Skip to main content

Sangmyung University Students Account Authentication.

Project description

sangmyung-univ-auth Python versions License Release

상명대학교 재학생 인증 라이브러리

Features

  • 상명대학교 재학생 여부를 간편하게 확인하는 라이브러리입니다.
  • 재학생 인증 방식은 상명대학교 e-Campus 세션 인증 방식입니다.

Easy to install

Pip: pip install sangmyung-univ-auth

Direct:

  • git clone https://github.com/hyunmin0317/sangmyung-univ-auth
  • python setup.py install

Easy to use

>>> from sangmyung_univ_auth import auth
>>> result = auth('201911019', '<my-password>')
>>> result
AuthResponse(is_auth=True, code='success', body={'name': '최현민', 'department': '컴퓨터과학전공', 'email': 'choihm9903@naver.com'})
>>> result.is_auth
True
>>> result.code
'success'
>>> result.body
{'name': '최현민', 'department': '컴퓨터과학전공', 'email': 'choihm9903@naver.com'}

AuthResponse

AuthResponse(
  is_auth=True,
  code='success',
  body={
    'name': '최현민', 
    'department': '컴퓨터과학전공', 
    'email': 'choihm9903@naver.com'
  }
)
  • is_auth: 인증 성공 여부
    • Type: bool
    • Value
      • True: 인증 성공
      • False: 인증 실패
  • code: Authenticator 반환 코드
    • Type: str
    • Value
      • 'success': 인증에 성공할 경우
      • 'auth_failed': 인증에 실패할 경우
      • 'unknown_issue': 기타 라이브러리 오류
  • body: 메타데이터
    • Type: dict
    • Key
      • name: 이름
      • department: 학과
      • email: 이메일

Sangmyung University Auth API

  • Request

    • URL
      https://smunity.co.kr/api/auth
      
    • Method POST
    • Body
      {
          "username": "<학번>",
          "password": "<비밀번호>"
      }
      
  • Response

    • Success: 200 OK
      {
          "is_auth": true,
          "code": "success",
          "body": {
              "name": "최현민",
              "department": "컴퓨터과학전공",
              "email": "choihm9903@naver.com"
          }
      }
      
    • Fail: 401 Unauthorized
      {
          "is_auth": false,
          "code": "auth_failed",
          "body": {
              "message": "아이디 및 비밀번호가 일치하지 않습니다."
          }
      }
      

References

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sangmyung-univ-auth-1.1.0.tar.gz (5.1 kB view hashes)

Uploaded Source

Built Distribution

sangmyung_univ_auth-1.1.0-py3-none-any.whl (6.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page