1.0.2 • Published 4 years ago

auth_sns v1.0.2

Weekly downloads
3
License
MIT
Repository
-
Last release
4 years ago

SNS Login SDK

  • Auth-SNS의 SDK입니다. SDK를 통해 사용자의 입장에서 별도의 회원가입을 하지 않고 사용자의 정보를 열람할 수 있습니다. SNS인증 사이트를 통해 로그인을 하게 되면 access token이 발급되는데, 이 토큰을 서버에서 사용자의 정보로 교환할 수 있습니다.

Usage

  1. 사용하려는 SNS 개발자 사이트에서 사용키 발급, 사이트 등록, callback 주소 등록

    1. Google

    2. Facebook

    3. Kakao

    4. Naver

  2. SDK 다운로드

    1. Gitlab을 통해 다운로드

      $ git clone http://scm.chelsea.kt.co.kr/sw_architecture_tf/commonmodule/auth-sns-module/auth_sns_js

    2. NPM을 통해 다운로드

      $ npm install auth_sns

  3. Package 설치
    $ npm install

  4. 모듈 로드

    var {변수명} = require('auth_sns/dist/auth_sns_sdk.min.js');

  5. 모듈 선언

    Facebook, Google, Naver, Kakao를 현재 지원하며 대소문자는 구분하지 않습니다.

     const sns = new module.SnsLoginModule('naver');
  6. 모듈 초기화에 쓰일 jsonData를 각 인증 사이트에 맞게 입력

    1. Google 예시

       let jsonData = {
          'clientID': '12345678-abcdefgh.apps.googleusercontent.com'
          };
    2. Facebook 예시

       let jsonData = {
          'appId': '12345678',
          'version': 'v8.0',
          'scope': 'email'
          };
    3. Kakao 예시

      let jsonData = {
          'appId': '12345678'
          };
    4. Naver 예시

       let jsonData = {
          'clientID': '12345678',
          'redirectURL': 'http://localhost:3001',
          'scope': 'name, profile, email'
          };
  7. 모듈 초기화

      sns.initSDK({서버주소}, jsonData);

사용가능한 함수

  1. InitSDK(server주소, jsonData)

    사용법은 위에 나와있습니다.

  2. login()

    로그인을 진행합니다.

  3. isLoggedIn()

    사용자의 로그인 상태를 확인할 수 있습니다. 로그인 상태일 때는 알림창에 true, 로그인 상태가 아닐 때는 false가 뜨는 것을 확인할 수 있습니다.

  4. getUserProfile()

    로그인한 경우 사용자의 정보를 JSON 형식으로 받아올 수 있습니다. 로그인 상태가 아닐 때는 사용자 정보를 볼 수 없습니다.

    var userData = sns.getUserProfile();
  5. logout()

    로그아웃할 수 있습니다. 로그인 상태가 아닐 때는 로그아웃되지 않습니다..

Customization

initSDK함수의 첫 번째 인자를 다른 값으로 변경시킬 수 있습니다. Auth-SNS-backend를 다운받고 실행한 상태를 가정하고 있기에 해당 코드가 실행되고 있는 다른 주소로 대체할 경우 access token을 해당 주소로 전송하게 됩니다.

사용 예시

Auth-SNS-Web-React

1.0.2

4 years ago

1.0.1

4 years ago