인증

FlipFlop 라이브러리를 이용하기 위해서는 제일 먼저, FlipFlop에서 발급받은 App Key와 App Secret Key를 이용하여 Access Token을 발급 받아야 합니다. 이번 인증 단계에서는 발급받은 키를 이용하여 토큰을 발급 받는 과정을 설명하고 있습니다.

설치

FlipFlip 라이브리러 소스는 npm 혹은 yarn을 통해 설치할 수 있습니다.

npm i --save-dev flipflop-sdk-javascript
# or
yarn add flipflop-sdk-javascript

SDK 인증

1. 라이브러리 가져오기

FlipFlip 코드는 UMD 방식으로 빌드된 라이브러리입니다. 따라서 import 또는 require 방식을 사용하여 라이브러리를 가져올 수 있습니다.

import { FlipFlop } from 'flipflop-sdk-javascript/dist/flipflop';
// or
const { FlipFlop } = require('flipflop-sdk-javascript/dist/flipflop');

2. 라이브러리 초기화

FlipFlop 인스턴스에 키를 등록하는 단계입니다.
FlipFlop 에서 발급받은 App Key 와 App Secret Key을 입력해주세요.

아직 키를 발급 받지 않았다면 시작전 필수사항을 참고해주세요.

// Initialize SDK
await FlipFlop.initialize(appKey: APP_KEY, appSecret: APP_SECRET)

3. 라이브러리 인증

초기화 단계에서 등록한 App Key 와 App Secret Key의 유효성을 검증하고 SDK에서 사용할 유저 정보를 입력하는 단계입니다.
유저 정보 입력시 아래의 사항을 유의하시기 바랍니다.
- 중복되지 않은 userID를 입력하세요.
  - userID 필드는 필수사항입니다.
  - 숫자 혹은 영문자만 입력 가능합니다. (a-zA-Z0-9)
  - 특수문자를 사용할 수 없습니다.
- userName과 avatarProfileURL은 선택사항입니다.
유저 정보와 각 키의 유효성이 검증하여 인증에 성공하게 되면 Access Token을 가진 SDK 라이브러리 인스턴스를 반환합니다.

const sdk = await FlipFlop.authentication(userID, userName, avatarProfileURL)

라이브러리 인증 명세서

필드명	타입	필수값	설명
userID	string	true	중복은 허용하지 않음. 숫자 혹은 영문자만 입력 가능. (a-zA-Z0-9)
userName	string	false	-
avatarProfileURL	string	false	-

4. 유저 정보 업데이트

만약 라이브러리 인증 단계 설정한 유저정보를 변경해야 할 경우에는 발급받은 sdk에서 유저 정보를 수정할 수 있습니다.

sdk.updateUserInfo(userName: "UpdatedUserName", avatarProfileURL: "avatarProfileURL");

유저 정보 업데이트 명세서

필드명	타입	필수값	설명
userName	string	false	-
avatarProfileURL	string	false	-

5. 토큰 외부로 가져오기

SDK 내부에 있는 AccessToken을 가져와 SDK 외부의 고객의 어플리케이션에서 직접적으로 FlipFlop API를 이용할 수 있습니다.

Access Token이 유출되지 않도록 주의하시기 바랍니다.

FlipFlop API는 문서를 참고해주시기 바랍니다.

const accessToken = sdk.getAccessToken();