romanization
- Print
- PDF
romanization
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
We are preparing a localization service for the content. We will do our best to provide the localization service as soon as possible.
Overview
Korean Name Romanizer API is a REST API that converts Korean names to romanized names. It is a non-login API, so encode a query string with UTF-8 and include it as a query request parameter in the request URL. Then, when you make a GET request, pass the Client ID and Client Secret values issued when registering your application, to the HTTP Header.
Request
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 issued when registering an application}" \
-H "X-NCP-APIGW-API-KEY: {Client Secret issued when registering an application}" -v
Request Parameters
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
query | string | Y | - | Korean name to romanize |
Request Header
Header | Description |
---|---|
X-NCP-APIGW-API-KEY-ID | Client ID issued when registering an appX-NCP-APIGW-API-KEY-ID:{Client ID} |
X-NCP-APIGW-API-KEY | Client Secret issued when registering an appX-NCP-APIGW-API-KEY:{Client Secret} |
Request Body
- No request body required.
Response
Response Body
Field | Type | Description |
---|---|---|
sFirstName | string | Unicode value for the last name |
aItems | object[] | Array of romanized names |
aItems[].name | string | Romanized name |
aItems[].score | string | Array of frequency integer values |
Examples
Request Example
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 issued when registering an application}" \
-H "X-NCP-APIGW-API-KEY: {Client Secret issued when registering an application}" -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 issued when registering an application}
> X-NCP-APIGW-API-KEY: {Client Secret issued when registering an application}
>
Request Example
< 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"}
]
}
]
}
Error Codes
HTTP status code | Error code | Error message | Measure |
---|---|---|---|
400 | 400 | Incorrect query request. | Required request parameter is invalid or missing. |
401 | 024 | Authentication failed. | Check if your Client ID and Secret are correct. |
401 | 024 | Scope Status Invalid. | Check your API permissions. |
403 | 072 | HTTPS only allowed : Unsupported protocol. | Please change your API URL protocol to https. |
404 | 051 | API does not exist. | Check if your API URL is correct. |
Was this article helpful?