romanization

개요

한국 인명을 로마자 표기로 변환해 주는 REST API입니다. 비인증 기반 API 이므로 요청 URL에 검색어를 UTF-8로 인코딩하여 query 요청 변수에 포함해 주시고, GET으로 호출할 때 HTTP Header에 애플리케이션 등록시 발급 받은 Client ID와 Client Secret 값을 같이 전송해 주시면 활용 가능합니다.

요청

curl "https://naveropenapi.apigw.ntruss.com/krdict/v1/romanization?query=%EA%B9%80%EC%A0%95%ED%99%98" \
    -H "X-NCP-APIGW-API-KEY-ID: {애플리케이션 등록 시 발급받은 client id 값}" \
    -H "X-NCP-APIGW-API-KEY: {애플리케이션 등록 시 발급받은 client secret 값}" -v

요청 파라미터

요청 변수명 타입 필수 여부 기본값 설명
query string Y - 로마자로 바꾸려는 한글 이름

요청 헤더

헤더명 설명
X-NCP-APIGW-API-KEY-ID 앱 등록 시 발급받은 Client ID
X-NCP-APIGW-API-KEY-ID:{Client ID}
X-NCP-APIGW-API-KEY 앱 등록 시 발급 받은 Client Secret
X-NCP-APIGW-API-KEY:{Client Secret}

요청 바디

  • 해당 API 는 요청 바디를 필요로 하지 않습니다.

응답

응답 바디

필드 타입 설명
sFirstName string 성에 대한 유니코드 값
aItems object[] 로마자 이름 배열
aItems[].name string 변환된 로마자 이름
aItems[].score string 빈도수 정수값 배열

예시

요청 예시

curl "https://naveropenapi.apigw.ntruss.com/krdict/v1/romanization?query=%EA%B9%80%EC%A0%95%ED%99%98" \
    -H "X-NCP-APIGW-API-KEY-ID: {애플리케이션 등록 시 발급받은 client id 값}" \
    -H "X-NCP-APIGW-API-KEY: {애플리케이션 등록 시 발급받은 client secret 값}" -v
> GET /v1/krdict/romanization?query=%EA%B9%80%EC%A0%95%ED%99%98 HTTP/1.1
> Host: naveropenapi.apigw.ntruss.com
> User-Agent: curl/7.49.1
> Accept: */*
> X-NCP-APIGW-API-KEY-ID: {애플리케이션 등록 시 발급받은 client id 값}
> X-NCP-APIGW-API-KEY: {애플리케이션 등록 시 발급받은 client secret 값}
>

응답 예시

< HTTP/1.1 200 OK
< Server: nginx
< Date: Wed, 28 Sep 2016 06:54:30 GMT
< Content-Type: application/json;charset=utf-8
< Content-Length: 271
< Connection: keep-alive
< Keep-Alive: timeout=5
< Vary: Accept-Encoding
<
* Connection #0 to host naveropenapi.apigw.ntruss.com left intact
{
    "aResult":[
        {
            "sFirstName":"\uae40","aItems":[
                {"name":"Kim Junghwan","score":"99"},
                {"name":"Kim Jeonghwan","score":"70"},
                {"name":"Kim Jungwhan","score":"39"},
                {"name":"Kim Jeongwhan","score":"27"},
                {"name":"Kim Jenghwan","score":"21"},
                {"name":"Kim Jengwhan","score":"8"}
            ]
        }
    ]
}

오류 코드

HttpStatusCode ErrorCode ErrorMessage Solution
400 400 Incorrect query request (잘못된 쿼리요청입니다.) 필수요청변수가 잘못되었거나 누락되었습니다.
401 024 Authentication failed. (인증에 실패했습니다.) 클라이언트아이디와 시크릿값이 정확한지 확인바랍니다.
401 024 Scope Status Invalid API 권한을 체크했는지 확인바랍니다.
403 072 HTTPS only allowed : Unsupported protocol (지원하지 않는 프로토콜입니다.) API URL을 https로 수정하시길 바랍니다.
404 051 API does not exist. (존재하지 않는 API입니다.) API URL 이 정확한지 확인하길 바랍니다.