Auth Token(인증 토큰) 발행

BizSpring AIR™ API를 사용하는 클라이언트 인증을 통해 API 사용 자격을 획득합니다.

인증 토큰 발행하기

인증 토큰은 Growth Platform™ API를 사용하기 위해 먼저 발행해야 하는 항목입니다.

• 토큰은 API 요청을 보낼 때 클라이언트를 인증하는데 사용되며, 각 요청 시 헤더에 포함되어야 합니다.

• 요청 성공 시 응답은 토큰과 토큰 정보를 포함합니다.

API 사용을 위해서는 활성화된 API 사용 권한을 보유한 Growth Platform™ 계정이 필요합니다.

계정 생성 또는 API 사용 권한이 있는지 확인이 필요한 경우 Growth Platform™ 계정 생성을 참고합니다.

요청 URL

아래 요청 URL로 계정 정보를 함께 요청하는 것으로서 인증 토큰을 발행 받고 획득하게 됩니다.

https://growthplatform.ai/auth/signin

프로토콜

HTTPS

HTTP 메서드

POST

Request Body

Request Body를 JSON 형식으로 전달(요청) 합니다.

키	타입	설명
username	string	사용자 계정의 고유 아이디를 의미합니다.
password	string	사용자 계정의 고유 비밀번호를 의미합니다.

요청 예

POST /auth/signin
HEADER
Content-Type: application/json

BODY
{
  "username": "{ADMIN_ID}",
  "password": "{ADMIN_PW}"
}


# JavaScript JQuery 
const sendData = {
  'username': "{username}",
  'password': "{password}"
};

let token;
$.ajax({
  url: 'https://growthplatform.ai/auth/signin',
  method: 'POST',
  contentType: 'application/json; charset=utf-8',
  data: JSON.stringify(sendData),
  success: function (data) {
    // success
    token = data.token;
  },
  error: function (error) {
    // error
  }
});

응답 결과 데이터

응답에 성공하면 JSON 형식으로 결과값이 반환됩니다.

파라미터	타입	설명
token_type	string	발행된 토큰의 타입. Bearer 로 고정
token	string	리포트 데이터 요청 시 사용되는 만료 기간이 있는 토큰

응답 예

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
  "token_type": "Bearer",
  "token": "eyJraWQiOiI0ZGE2YmYxNy0wYTZmL....SrYiSAX7lZhc-rxKbrooQ8KQ-Dq7CV1tA"
}

HTTP Request에 대한 200 OK 응답이 아닌 경우는 username 및 password의 오류가 아닌, 클라이언트-API서버와의 통신문제이거나 기타 문제입니다.

이 경우에는 HTTP 표준 응답 코드를 참고하시기 바랍니다.