API 인증

개요

WalkInsights에서 제공하는 API를 이용하기 위해서는 인증이 필요합니다. 이 문서는 API 요청을 사용하기 위한 인증 방법에 대해 알아봅니다.

🚧

WalkInsights 서비스 계정 필요

아직 WalkInsights 서비스 계정이 없다면 지원 부서로 문의하시기 바랍니다([email protected]).

Step1: 인증 토큰 확인

WalkInsights 제품군에서 제공하는 모든 API를 이용하기 위해서는 authentication_token 이라고 부르는 문자열이 필요합니다. 이 토큰값은 Sign-In API를 이용하면 얻어올 수 있습니다. 또한, 이 토큰값은 유저별로 고유한 값이기 때문에, API 사용시마다 매번 요청할 필요 없이 1회 요청 이후에 메모해놓으셨다가 계속해서 사용하실 수 있습니다.

🚧

인증 토큰은 유저별로 고유하게 발급되는 API 인증 키이기 때문에 잃어버리지 않도록 주의하세요.

인증 토큰 요청

아래와 같은 방법으로 이 토큰을 요청하실 수 있습니다.

📘

https://api.walkinsights.com/api/v1/users/sign_in

[form-data]
user[email] : YOUR_EMAIL
user[password] : PASSWORD

인증 토큰 확인

위와 같이 요청하면 authentication_token 값이 포함되어 있는 user 오브젝트를 얻을 수 있습니다.

{
  "user": {
    "email": "[email protected]",
    "mobile_number": "+821012345678",
    "enable_sms_notification": false,
    "locale": "",
    "authentication_token": "JGBZhPPiVw4zY5gAecz5",
    "id": 123,
    "name": "Someone John Doe",
    "role": "admin",
    "image_thumb_url": "...",
    "image_original_url": "..."
  }
}

웹사이트에서 로그인 이후 토큰 확인

웹사이트에서 로그인 이후에는 Users/Me API를 사용하면 위의 응답 결과를 다시 확인하실 수 있습니다. 이 때에는 HTTP 클라이언트 프로그램이 필요하지 않으며, 로그인 과정에서 웹브라우저에 세션이 생성되어 있는 상태이므로, 웹브라우저에서 요청하셔도 결과를 보실 수 있습니다.

📘

https://api.walkinsights.com/api/v1/users/me

웹사이트에서 로그인 하지 않은 경우라면 아래와 같이 헤더 설정이 필요합니다.

[headers]
X-User-Email : YOUR_EMAIL
X-User-Token : YOUR_AUTHENTICATION_TOKEN

Step2: API 요청 시 인증 토큰 사용하기

각각의 API를 호출할 때, 이전에 확인한 authentication_token을 HTTP 요청의 헤더에 넣습니다.

[headers]
X-User-Email : YOUR_EMAIL
X-User-Token : YOUR_AUTHENTICATION_TOKEN

REST 클라이언트 사용하기

WalkInsights는 편리한 인증을 위해 REST client를 제공하고 있습니다.

Java

Rest Client - Java