공공데이터 e약은요? 연동 중 서비스 키 등록 안됨 문제 해결 과정

서비스 키 등록 안됨 에러 

api 호출을 시도하는 과정에서 service key가 등록되어있지 않다는 에러가 발생하였다. 

??????

이게 매번 에러가 뜨는 것도 아니고 어쩔 때는 정상 작동하다가 어떤 때에는 또 에러가 발생해서 데이터를 불러올 수 없었다.

발급받은 공공데이터 포털 인증키를 복사 붙여넣기해서 넣었기 때문에 오타가 있는 것도 아니었다. 정상 작동이 될 때도 있으니까!! 

그럼 도대체 뭐가 문제일까?

---

🕵️ 문제 발견! 

에러가 뜰 때 호출된 경로를 타고 들어가보니  파라미터로 들어가는 서비스 키가 다르게 들어가고 있음을 알게되었다!

실제 서비스 키에는 25 라는 수는 없는데, 실제로 api 를 호출할 때 들어가는 서비스 키는 253D로 들어가고 있었다.

 

api 호출 시 들어가는 서비스 키 일부  :  %253D%253D

실제 서비스 키  : %3D%3D

 

---

 

공공 데이터 포털에서는 아래와 같이 2종료의 인증키를 제공한다.

하나는 URL에서 사용이 가능하도록 인코딩된 인증키와 , 다른 하나는 인코딩되지 않은 원본 인증키이다.

 

 

인코딩 디코딩이란?

인코딩이란 정해진 규칙에 따라서 코드화, 암호화, 부호화 하는 것을 의미한다.

 

" 나 치킨 먹고싶어" 라는 말을 내 친구만 알아들을 수 있었으면 좋겠어! 라고 하면 "나 치킨 먹고싶어" 라는 말을 encoding하고, 코드화된 (인코딩된) 말을 친구는 서로 공유한 규칙에 따라 decoding 해주면 된다

 

나의 경우처럼 서비스 키를 string으로 넘기는 경우에는 자동으로 인코딩이 일어나기 때문에 인코딩 인증키가 아니라 디코딩된 인증키를 넘겨줘야한다! 

만약 그냥 인코딩 된 인증키를 사용할 경우 한 번 더 인코딩이 일어나 제공된 서비스 키와 인증키가 달라지게 된다.

그래서 계속 등록되어있지 않은 서비스 키라는 에러가 발생한 것이었다.

---

해결

1. 인코딩된 인증키를 이용하는 경우

만약 인코딩된 인증키를 이용하려면 아래와 같이 URLDecoder 를 사용하여 해당 인증키를 디코딩해준 후 이 serviceKey를 api 호출 시에 사용해주면 된다.

val serviceKey = URLDecoder.decode(SERVICE_KEY, "UTF-8")

 

2. 디코딩된 인증키를 이용하는 경우

companion object {
    const val SERVICE_KEY = "디코딩된 인증키"
}

 

위와 같이 SERVICE_KEY 를 정의해두고  api 호출시 파라미터로 넘겨주면 된다 . 

나는 2번 방법을 이용해주었다.