README.md

✅ 단 한 줄의 코드로 메일 및 대학 인증 서비스 사용하기

🐣 초보자를 위한 UnivCert의 라이브러리 배포

자세한 설명은 해당 사이트에서도 확인하실 수 있습니다.

💡 build.gradle에 해당 코드 두 줄 추가

repositories{
  ...
  maven {url 'https://jitpack.io'}
}

dependencies{
  ...
  implementation 'com.github.in-seo:univcert:master-SNAPSHOT'
  ...
}

✉ 이용자 메일 인증 시작 (인증코드 발송)

UnivCert.certify("key", "email", "univName", univ_check(bool));

• -> 하단 json 형태로 자동 변환 및 http 전송 POST(univcert.com/api/v1/certify)

{
  “key” : “부여받은 API KEY”,
  "email” : “[email protected]”,
  “univName” : “홍익대학교”,
  “univ_check” : true
	(true라면 해당 대학 재학 여부, false라면 메일 소유자 인증만)
}

✅ 이용자 메일에 발송된 코드를 전달 받아 인증 받기

UnivCert.certifyCode("key", "email", "univName", 인증코드(int));

• -> 하단 형태로 자동 변환 및 http 전송 POST(univcert.com/api/v1/certifycode)

{
  “key” : “부여받은 API KEY”
  “email” : "[email protected]”,
  “univName” : “홍익대학교”,
  “code” : 3816
}

🆗 응답 성공 시 인증 끝 !

---

이외 기능

📂 인증된 이메일인지 확인 기능

UnivCert.status("key","email");

• -> 하단 json 형태로 자동 변환 및 http 전송 POST(univcert.com/api/v1/status)

{
  “key” : “부여받은 API KEY”,
  "email” : “[email protected]”
}

📜 해당 API 키로 인증된 유저 리스트 출력

UnivCert.list("key"); --> 하단 json 형태로 자동 변환 및 http 전송 POST(univcert.com/api/v1/certifiedlist)

{
  “key” : “부여받은 API KEY”
}

⚠️ 인증 가능한 대학교 명인지 체킹

UnivCert.check("univName"); --> 하단 json 형태로 자동 변환 및 http 전송 POST(univcert.com/api/v1/check)

{
  "univName" : "인증 요청 할 대학명 
     (올바른 대학명인지, 22년 기준 입학생 수 상위 150개 이내에 드는 학교인지)"
}

🆕 현재 인증 된 유저목록 초기화

UnivCert.clear("key"); --> 하단 json 형태로 자동 변환 및 http 전송 POST(univcert.com/api/v1/clear)

{
  “key” : “부여받은 API KEY”
}

📛 현재 인증 된 "특정" 유저 초기화

UnivCert.clear("key", "email"); --> 하단 json 형태로 자동 변환 및 http 전송 POST(univcert.com/api/v1/clear/초기화 하고 싶은 email)

{
  “key” : “부여받은 API KEY”
}

👼 상단 certify, certifycode 의 메서드로 대학 인증 절차를 간편하게 끝낼 수 있습니다.

라이브러리 적용 문제 발생 시

1. gradle 의 버전이 일치하지 않아서 생기는 문제일 수 있습니다.

   프로젝트 경로/gradle/wrapper/gradle-wrapper.properties 에서

   distributionUrl 을 하단의 버전으로 바꿔서 재빌드 해주세요.

   distributionUrl=https://services.gradle.org/distributions/gradle-7.1-bin.zip

   7.1 이후 버전, 즉 최신 버전인 8.2버전과 자바 17에서도 작동 되는 거 확인했습니다. (23.08.14)

---

2. gradle이 라이브러리를 인식하지 못해서 생기는 문제입니다.

gradle 탭에서 Reload Gradle Project 하시면 정상적으로 실행 가능합니다.

---

3. Socket timeOut Exception

   UnivCert 측 서버의 문제입니다. 드문 경우겠지만 문의 주시면 바로 복구하겠습니다.