Skip to content

Back End API

Jump to bottom
LimeCake edited this page Jul 3, 2020 · 7 revisions

Pay-Map back-end API document

Geocoding via Naver

http://devx.kr:9991/geocode

GET 형식으로 request를 보내주세요

Example http://devx.kr:9991/geocode?address=성신로%2099|성신로%2097&coordinate=127.1054328,37.3595963

Request

Field Type Essential Description
id String No 네이버 API 요청 아이디
key String No 네이버 API 요청 키
address String Yes "|"로 구분되는 주소 배열 (ex.고양시 성신로 99 | 성신로 97)
coordinate String Yes 결과가 복수일 시 거리에 따라 우선순위를 부여하기 위한 좌표

Response

JSON Object

Example

[
  {
    "status": "OK",
    "meta": {
      "totalCount": 1,
      "page": 1,
      "count": 1
    },
    "addresses": [
      {
        "roadAddress": "경기도 고양시 덕양구 성신로 99 햇빛마을19단지아파트",
        "jibunAddress": "경기도 고양시 덕양구 행신동 903 햇빛마을19단지아파트",
        "englishAddress": "99, Seongsin-ro, Deogyang-gu, Goyang-si, Gyeonggi-do, Republic of Korea",
        "addressElements": [
          {
            "types": [
              "SIDO"
            ],
            "longName": "경기도",
            "shortName": "경기도",
            "code": ""
          },
          {
            "types": [
              "SIGUGUN"
            ],
            "longName": "고양시 덕양구",
            "shortName": "고양시 덕양구",
            "code": ""
          },
          {
            "types": [
              "DONGMYUN"
            ],
            "longName": "행신동",
            "shortName": "행신동",
            "code": ""
          },
          {
            "types": [
              "RI"
            ],
            "longName": "",
            "shortName": "",
            "code": ""
          },
          {
            "types": [
              "ROAD_NAME"
            ],
            "longName": "성신로",
            "shortName": "성신로",
            "code": ""
          },
          {
            "types": [
              "BUILDING_NUMBER"
            ],
            "longName": "99",
            "shortName": "99",
            "code": ""
          },
          {
            "types": [
              "BUILDING_NAME"
            ],
            "longName": "햇빛마을19단지아파트",
            "shortName": "햇빛마을19단지아파트",
            "code": ""
          },
          {
            "types": [
              "LAND_NUMBER"
            ],
            "longName": "903",
            "shortName": "903",
            "code": ""
          },
          {
            "types": [
              "POSTAL_CODE"
            ],
            "longName": "10483",
            "shortName": "10483",
            "code": ""
          }
        ],
        "x": "126.8401797",
        "y": "37.6280612",
        "distance": 37905.64
      }
    ],
    "errorMessage": ""
  },
  {
    "status": "OK",
    "meta": {
      "totalCount": 1,
      "page": 1,
      "count": 1
    },
    "addresses": [
      {
        "roadAddress": "경기도 고양시 덕양구 성신로 97 햇빛마을19단지",
        "jibunAddress": "경기도 고양시 덕양구 행신동 904 햇빛마을19단지",
        "englishAddress": "97, Seongsin-ro, Deogyang-gu, Goyang-si, Gyeonggi-do, Republic of Korea",
        "addressElements": [
          {
            "types": [
              "SIDO"
            ],
            "longName": "경기도",
            "shortName": "경기도",
            "code": ""
          },
          {
            "types": [
              "SIGUGUN"
            ],
            "longName": "고양시 덕양구",
            "shortName": "고양시 덕양구",
            "code": ""
          },
          {
            "types": [
              "DONGMYUN"
            ],
            "longName": "행신동",
            "shortName": "행신동",
            "code": ""
          },
          {
            "types": [
              "RI"
            ],
            "longName": "",
            "shortName": "",
            "code": ""
          },
          {
            "types": [
              "ROAD_NAME"
            ],
            "longName": "성신로",
            "shortName": "성신로",
            "code": ""
          },
          {
            "types": [
              "BUILDING_NUMBER"
            ],
            "longName": "97",
            "shortName": "97",
            "code": ""
          },
          {
            "types": [
              "BUILDING_NAME"
            ],
            "longName": "햇빛마을19단지",
            "shortName": "햇빛마을19단지",
            "code": ""
          },
          {
            "types": [
              "LAND_NUMBER"
            ],
            "longName": "904",
            "shortName": "904",
            "code": ""
          },
          {
            "types": [
              "POSTAL_CODE"
            ],
            "longName": "10483",
            "shortName": "10483",
            "code": ""
          }
        ],
        "x": "126.8395999",
        "y": "37.6272945",
        "distance": 37870.32
      }
    ],
    "errorMessage": ""
  }
]

ZeroPay Shop Search

http://devx.kr:9991/zeropay

GET 형식으로 request를 보내주세요

Example http://devx.kr:9991/zeropay?sido=1&sigungu=7&address=중앙로&type=편의점&max=100

Request

Field Type Essential Description
sido Number Yes 요청 검증을 위한 키
sigungu Number Yes 요청 검증을 위한 키
address String - 주소 (ex.능동로)
name String - 상호명 (ex.낙지)
type String - 업종명 (ex.한식)
max Number No 결과가 많을 경우 받을 한도 (ex.100) (최대값 1000)

주소로 검색하고자 하는 경우 address 필수

상호명으로 검색하고자 하는 경우 name 필수

업종으로 검색하고자 하는 경우 type 필수

Response

JSON Array Example

[
  {
    "shop_index": 5109,
    "shop_name": "GS25 구로은혜점",
    "shop_sido": 1,
    "shop_sigungu": 7,
    "shop_address": "중앙로15길 87 (고척동 220-16)",
    "shop_type": "편의점"
  },
  {
    "shop_index": 5845,
    "shop_name": "GS25고척센츄리점",
    "shop_sido": 1,
    "shop_sigungu": 7,
    "shop_address": "중앙로12길 12, 상가 101호(고척1동 320, 센츄리)",
    "shop_type": "편의점"
  },
  {
    "shop_index": 5994,
    "shop_name": "GS25구로중앙로점",
    "shop_sido": 1,
    "shop_sigungu": 7,
    "shop_address": "중앙로3길 12 (고척동 76-22)",
    "shop_type": "편의점"
  },
  {
    "shop_index": 6005,
    "shop_name": "GS25구로한일점",
    "shop_sido": 1,
    "shop_sigungu": 7,
    "shop_address": "중앙로15길 151, 101동 105호(고척2동 337, 한일유앤아이)",
    "shop_type": "편의점"
  },
  {
    "shop_index": 93844,
    "shop_name": "세븐일레븐 고척푸르지오점",
    "shop_sido": 1,
    "shop_sigungu": 7,
    "shop_address": "중앙로109 (고척동, 고척파크푸리지오) (주)코리아세븐 고척푸르지오점",
    "shop_type": "편의점"
  },
  {
    "shop_index": 93923,
    "shop_name": "세븐일레븐 구로고척본점",
    "shop_sido": 1,
    "shop_sigungu": 7,
    "shop_address": "중앙로 85(고척동, 라이프플러스 102호) (주)코리아세븐 구로고척본점",
    "shop_type": "편의점"
  },
  {
    "shop_index": 109604,
    "shop_name": "씨유고척리가점",
    "shop_sido": 1,
    "shop_sigungu": 7,
    "shop_address": "중앙로14길 23, (고척동)",
    "shop_type": "편의점"
  },
  {
    "shop_index": 109760,
    "shop_name": "씨유구로리더스점",
    "shop_sido": 1,
    "shop_sigungu": 7,
    "shop_address": "중앙로6길 22, 1층 101호, 102호(고척동, 대림리더스오피스텔)",
    "shop_type": "편의점"
  },
  {
    "shop_index": 110980,
    "shop_name": "씨유신원프라자점",
    "shop_sido": 1,
    "shop_sigungu": 7,
    "shop_address": "중앙로1길 18-18, (고척동, 신원프라자) 1층",
    "shop_type": "편의점"
  },
  {
    "shop_index": 143692,
    "shop_name": "이마트24고척유니츠점",
    "shop_sido": 1,
    "shop_sigungu": 7,
    "shop_address": "중앙로14길 7 1층",
    "shop_type": "편의점"
  }
]
Clone this wiki locally