{"info":{"_postman_id":"f6a7967d-f349-4c0a-ab87-18614e947c59","name":"APTNER API Docs","description":"

아파트너는 파트너사들과 시너지를 내기 위한 개발 환경을 제공합니다.

\n\n
\n

Getting started guide

\n

아파트너 Open API를 사용하시려면 사용 형태에 따라 key를 발급받아야 합니다.

\n\n
\n

Authentication

\n

Basic-Auth 방식

\n

웹브라우저에서 URL만 입력하면 웹사이트에 접속하는 것이 아니라, header에 Basic-Auth 인증을 태워야지만 웹사이트 접속을 허용하는 방식입니다.

\n

아파트너 사용자들에게만 웹사이트 접속을 허용하기 위해 아파트너 앱 내 웹뷰에서만 서비스를 제공하고 외부 웹브라우저에서는 해당 웹사이트에 대한 트래픽을 막는 용도로 사용됩니다.

\n

\bex) 아파트너 입주민 혜택용 제휴사 사이트

\n

Basic-Auth 계정 발급 방법

\n

(Open API Center 준비중)

\n

수동 발급 방법

\n

아파트너에서 띄우고자 하는 사이트의 URL을 dev@aptner.com 으로 보내주세요

\n

메일 회신으로 Basic-Auth계정을 보내드리겠습니다.

\n\n

Basic-Auth 사용 방법

\n

사이트 구축시 아파트너에서 발급 받은 Basic-Auth계정으로 http header에 Basic-Auth 인증 방식을 구현해주세요

\n

header 정의

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyValueDescription
AuthorizationBasic {{token}}일반적인 Basic-Auth,
token = Base64({{interfaceId}}:{{interfacePw}})
\n

아파트너는 Basic-Auth계정 발급시 입력했던 URL 호출시 Basic-Auth를 위와 같은 방식으로 header에 넣어서 보내드립니다.

\n

Secret Key 방식

\n

웹사이트 파라미터로 개인정보를 직접 입력하는 것이 아니라, 아파트너와 제휴사의 약속된 대칭키로 회원 정보를 암호화하여 통신하는 방식입니다.

\n

무분별한 파라미터 위변조 접근을 막고 계약된 제휴사에게 안전하게 회원정보를 전달하기 위함입니다.

\n

\bSecret Key 발급 방법

\n

(Open API Center 준비중)

\n

수동 발급 방법

\n

아파트너에서 연동하고자 하는 사이트의 URL, 회원 정보, 약관을 dev@aptner.com 으로 보내주세요

\n

메일 회신으로 \bSecret Key를 보내드리겠습니다.

\n

Token 발급시 필요한 정보

\n\n

Secret Key 사용 방법

\n

회원 정보를 암호화 하는 방식은 AES256 대칭키 암호화 알고리즘을 사용합니다.

\n\n

사이트 구축시 아파트너에서 발급받은 token으로 header에 전달되는 Data를 복호화 하여 사용해주세요

\n

header 정의

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyValueDescription
DataAES256({{Json format data}})Json 형식의 회원 정보를 대칭키로 AES256 암호화 하여 전송
Json format data sample:
{
\"id\":\"abcd1234\"
}
\n

아파트너는 \bToken 발급시 입력했던 URL 호출시 회원 정보를 위와 같은 방식으로 header에 넣어서 보내드립니다.

\n

API key 방식

\n

아파트너에서 제공하는 다양한 Open API를 사용하기 위한 인증 방식입니다.

\n

아파트너는 사전 협의된 제휴사에게만 API를 제공합니다.

\n

API Key 계정 발급 방법

\n

(Open API Center 준비중)

\n

수동 발급 방법

\n

아파트너에서 연동하고자 하는 사이트의 URL, 회원 정보, 약관을 dev@aptner.com 으로 보내주세요

\n

메일 회신으로 \bAPI Key(Access Key, Secret Key)을 보내드리겠습니다.

\n

API Key 발급시 필요한 정보

\n\n

\bAPI Key 사용 방법

\n

아파트너는 RFC2014 표준 암호화 프로토콜인 HMAC(keyed-hash message authentication code)를 사용하여 인증을 처리합니다.

\n

Open API 요청시 header엔 하단 key-value가 필수로 필요합니다.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyValue
\bApi-Key아파트너에서 발급받은 Access Key
Api-Noncerandom uuid
Api-SignEnd Point
+ Request Parameter
+ Api-Nonce
+ 사용자 Secret Key를
조합하여 인코딩한 값
\n
    \n
  1. Request Parameter 조합
      \n
    1. endpoint 파라미터 추가
      /v2/parking/in?indate=20240101&outdate=20240101
      2. \n
    2. URL 인코딩
      /v2/parking/in?indate=20240101&outdate=20240101
      3. \n
    \n
    2. \n
  2. End Point + Request Parameter + Api-Nonce 조합
      \n
    1. 구분자 없이 3개의 값을 조합합니다
      /v2/parking/in?indate=20240101&outdate=202401013b1d8bd3-4b7c-45f8-9f9b-d9503e236df0
      2. \n
    \n
    3. \n
  3. HmacSha256 알고리즘으로 인코딩
      \n
    1. 2번에서 조합한 값을 사용자의 Secret Key를 이용하여 인코딩합니다.
      2. \n
    \n
    4. \n
  4. Base64 인코딩
      \n
    1. HmacSha256로 인코딩한 값을 다시 Base64로 인코딩합니다.
      2. \n
    \n
    5. \n
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting started guide","slug":"getting-started-guide"},{"content":"Authentication","slug":"authentication"},{"content":"Basic-Auth 방식","slug":"basic-auth"},{"content":"Secret Key 방식","slug":"secret-key"},{"content":"API key 방식","slug":"api-key"}],"owner":"22956199","collectionId":"f6a7967d-f349-4c0a-ab87-18614e947c59","publishedId":"2s9YsKhXxd","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00A8FF"},"publishDate":"2024-01-15T13:29:56.000Z"},"item":[{"name":"New Request","id":"c6890038-e682-4047-bac5-7d80c7494a09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"c6890038-e682-4047-bac5-7d80c7494a09"}],"event":[{"listen":"prerequest","script":{"id":"c591cf1a-d450-444e-8918-70bf3c634006","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2ca9fb2e-53be-4ed6-82ca-3775d6ee5b32","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://farming-simulator.pstmn.io"}]}