{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"f6a7967d-f349-4c0a-ab87-18614e947c59","name":"APTNER API Docs","description":"아파트너는 파트너사들과 시너지를 내기 위한 개발 환경을 제공합니다.\n\n- 아파트너에서 제공하는 Open API를 통해서 아파트너의 다양한 기능을 사용할 수 있습니다.\n- Open API를 이용하여 주차관제 데이터 동기화, 방문차량 예약 조회 등이 가능합니다.\n- Open API를 통해 아파트, 회원 고유 식별값 등을 암호화 프로토콜을 통해 전달받을 수 있습니다.\n    \n\n---\n\n# **Getting started guide**\n\n아파트너 Open API를 사용하시려면 사용 형태에 따라 key를 발급받아야 합니다.\n\n- 아파트너 앱 내 웹뷰에서만 접근 가능한 웹사이트를 구성하고자 한다면 [Basic-Auth](https://api-docs.aptner.com/)를 활용해 보세요\n- 아파트너 회원 정보 연동을 통한 비즈니스를 구축하고자 한다면 [Secret Key 방식](https://api-docs.aptner.com/)을 활용해 보세요\n- 아파트너 Open API를 통해 다양한 기능을 활용하시고자 한다면 [API key 방식](https://api-docs.aptner.com/)을 활용해 보세요\n    \n\n---\n\n# Authentication\n\n# Basic-Auth 방식\n\n웹브라우저에서 URL만 입력하면 웹사이트에 접속하는 것이 아니라, header에 Basic-Auth 인증을 태워야지만 웹사이트 접속을 허용하는 방식입니다.\n\n아파트너 사용자들에게만 웹사이트 접속을 허용하기 위해 아파트너 앱 내 웹뷰에서만 서비스를 제공하고 외부 웹브라우저에서는 해당 웹사이트에 대한 트래픽을 막는 용도로 사용됩니다.\n\n\bex) 아파트너 입주민 혜택용 제휴사 사이트\n\n## Basic-Auth 계정 발급 방법\n\n(Open API Center 준비중)\n\n수동 발급 방법\n\n아파트너에서 띄우고자 하는 사이트의 URL을 [dev@aptner.com](https://mailto:dev@aptner.com) 으로 보내주세요\n\n메일 회신으로 Basic-Auth계정을 보내드리겠습니다.\n\n- URL은 Basic-Auth와 1:1 맵핑됩니다\n- URL은 HOST가 아닌 Basic-Auth방식으로 인증을 태우는 화면 URL을 보내주세요\n    \n\n## Basic-Auth 사용 방법\n\n사이트 구축시 아파트너에서 발급 받은 Basic-Auth계정으로 http header에 Basic-Auth 인증 방식을 구현해주세요\n\nheader 정의\n\n| **Key** | **Value** | **Description** |\n| --- | --- | --- |\n| Authorization | Basic {{token}} | 일반적인 Basic-Auth,  <br>token = Base64({{interfaceId}}:{{interfacePw}}) |\n\n아파트너는 Basic-Auth계정 발급시 입력했던 URL 호출시 Basic-Auth를 위와 같은 방식으로 header에 넣어서 보내드립니다.\n\n# Secret Key 방식\n\n웹사이트 파라미터로 개인정보를 직접 입력하는 것이 아니라, 아파트너와 제휴사의 약속된 대칭키로 회원 정보를 암호화하여 통신하는 방식입니다.\n\n무분별한 파라미터 위변조 접근을 막고 계약된 제휴사에게 안전하게 회원정보를 전달하기 위함입니다.\n\n## \bSecret Key 발급 방법\n\n(Open API Center 준비중)\n\n수동 발급 방법\n\n아파트너에서 연동하고자 하는 사이트의 URL, 회원 정보, 약관을 [dev@aptner.com](https://mailto:dev@aptner.com) 으로 보내주세요\n\n메일 회신으로 \bSecret Key를 보내드리겠습니다.\n\nToken 발급시 필요한 정보\n\n- 연동하고자 하는 사이트의 URL\n    - URL은 HOST가 아닌 \bToken방식으로 회원 정보를 연동하는 화면 URL을 보내주세요\n- 연동하고자 하는 회원 정보\n- 약관 정보\n    - 이용약관\n    - 제휴사 개인정보 제3자 제공 동의\n    - 제휴사 개인정보 수집 및 이용 동의\n\n## Secret Key 사용 방법\n\n회원 정보를 암호화 하는 방식은 AES256 대칭키 암호화 알고리즘을 사용합니다.\n\n- 암호화 방식: AES256\n- Cipher Mode: CBC\n- Padding Schema: PKCS7\n    \n\n사이트 구축시 아파트너에서 발급받은 token으로 header에 전달되는 Data를 복호화 하여 사용해주세요\n\nheader 정의\n\n| **Key** | **Value** | **Description** |\n| --- | --- | --- |\n| Data | AES256({{Json format data}}) | Json 형식의 회원 정보를 대칭키로 AES256 암호화 하여 전송  <br>Json format data sample:  <br>{  <br>\"id\":\"abcd1234\"  <br>} |\n\n아파트너는 \bToken 발급시 입력했던 URL 호출시 회원 정보를 위와 같은 방식으로 header에 넣어서 보내드립니다.\n\n# API key 방식\n\n아파트너에서 제공하는 다양한 Open API를 사용하기 위한 인증 방식입니다.\n\n아파트너는 사전 협의된 제휴사에게만 API를 제공합니다.\n\n## API Key 계정 발급 방법\n\n(Open API Center 준비중)\n\n수동 발급 방법\n\n아파트너에서 연동하고자 하는 사이트의 URL, 회원 정보, 약관을 [dev@aptner.com](https://mailto:dev@aptner.com) 으로 보내주세요\n\n메일 회신으로 \bAPI Key(Access Key, Secret Key)을 보내드리겠습니다.\n\nAPI Key 발급시 필요한 정보\n\n- 연동하고자 하는 서버의 IP 정보(복수개 가능)\n- 연동하고자 하는 사이트의 HOST URL\n    \n\n## \bAPI Key 사용 방법\n\n아파트너는 [RFC2014 표준](https://www.ietf.org/rfc/rfc2104.txt) 암호화 프로토콜인 HMAC(keyed-hash message authentication code)를 사용하여 인증을 처리합니다.\n\nOpen API 요청시 header엔 하단 key-value가 필수로 필요합니다.\n\n| **Key** | **Value** |\n| --- | --- |\n| \bApi-Key | 아파트너에서 발급받은 Access Key |\n| Api-Nonce | random uuid |\n| Api-Sign | End Point  <br>\\+ Request Parameter  <br>\\+ Api-Nonce  <br>\\+ 사용자 Secret Key를  <br>조합하여 인코딩한 값 |\n\n1. Request Parameter 조합\n    1. endpoint 파라미터 추가  \n        `/v2/parking/in?indate=20240101&outdate=20240101`\n    2. URL 인코딩  \n        `/v2/parking/in?indate=20240101&outdate=20240101`\n2. End Point + Request Parameter + Api-Nonce 조합\n    1. 구분자 없이 3개의 값을 조합합니다  \n        `/v2/parking/in?indate=20240101&outdate=202401013b1d8bd3-4b7c-45f8-9f9b-d9503e236df0`\n3. HmacSha256 알고리즘으로 인코딩\n    1. 2번에서 조합한 값을 사용자의 Secret Key를 이용하여 인코딩합니다.\n4. Base64 인코딩\n    1. HmacSha256로 인코딩한 값을 다시 Base64로 인코딩합니다.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"22956199","collectionId":"f6a7967d-f349-4c0a-ab87-18614e947c59","publishedId":"2s9YsKhXxd","public":true,"publicUrl":"https://api-docs.aptner.com","privateUrl":"https://go.postman.co/documentation/22956199-f6a7967d-f349-4c0a-ab87-18614e947c59","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00A8FF"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/e54c3fbf-e261-4a98-8dab-11840e1a8739/QklfdGV4dC5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"00A8FF"}},{"name":"light","logo":"https://content.pstmn.io/29f08333-a4da-47bf-86aa-b5913dcabd74/QklfdGV4dC5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00A8FF"}}]}},"version":"8.10.1","publishDate":"2024-01-15T13:29:56.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/29f08333-a4da-47bf-86aa-b5913dcabd74/QklfdGV4dC5wbmc=","logoDark":"https://content.pstmn.io/e54c3fbf-e261-4a98-8dab-11840e1a8739/QklfdGV4dC5wbmc="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://aptner.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api-docs.aptner.com/view/metadata/2s9YsKhXxd"}