도로명주소 API 사용하기(부제: 에러코드 E0005)

안드로이드 프로젝트를 진행하는데 도로명으로 검색해야할 일이 생겼습니다.

어디서 API 를 가져다가 쓸지 찾다가 복잡하지 않고 바로 사용할수 있어보이는곳을 발견하였습니다.

https://www.juso.go.kr/addrlink/main.do?cPath=99MM 

도로명주소 개발자센터

 

실제로 API를 사용하기 위해서는 3 단계의 절차를 거쳐야 합니다.

1. API 신청하여 인증키 발급

2. 사용법 및 입력가능한 키값들 확인

3. 실제 값 받아지는지 테스트

 

 

1. API 신청하기를 통해서 인증키를 발급 받습니다.

 

인증키를 발급 받았으면 도로명 주소API 버튼을 선택해서 아래 화면으로 이동합니다.

 

2. 도로명 주소 API 에서 어떤식으로 사용하고 어떤 키값들이 필요한지 확인해 보기 위해 API정보/요청변수/출력결과보기 를 선택합니다.

위와 같이 API 와 관련된 정보를 확인할 수 있습니다.

이제 실제 개발에 들어가기 전에 값이 잘 받아지는지 테스트를 해봅니다.

테스트는 postman 을 이용하였습니다.

 

3. postman 에서 주소를 입력하고 body 에 json 타입의 raw 로 필수 키값들을 입력 후 요청을 보내보았습니다.

post 전송 결과

인증키값 제대로 넣고 나머지 값들도 이상없는거 같은데 검색어가 입력되지 않았다고 나오네요.

에러코드 E0005 가 출력 되었습니다.

 

가이드 문서를 확인해 보니 에러코드 정의가 나와있습니다.

에러코드 정의

이상이 없다고 생각되는데 몇 번을 해봐도 같은 응답만 나타납니다.

뭔가 키워드 값이 안맞는것 같다고 판단 되어 가이드 문서를 조금 더 읽어보았습니다.

문서를 보다보니 해결 실마리로 보이는 내용이 있었습니다.

인코딩 문제때문에 안된다고 생각이 들어서 postman 에서 body 에 raw 가 아니고 x-www-form-urlencoded 로 변경하여 값들을 넣고 요청하였습니다.

 

인코딩을 해서 보내니까 이상없이 잘 나타났습니다.

 

 

약간의 헤멤이 있었지만 결과가 잘 나타남을 확인하였습니다.

이제 안드로이드로 retrofit 을 이용하여 개발만 진행하면 될 것 같습니다.

 

 

 

추후 똑같은 삽질 방지 및 주소연동 API 테스트가 수월치 않은 분들에게 조금이나마 도움이 되면 좋을것같아서 작성하였습니다.