nShortURL overview
- Print
- PDF
nShortURL overview
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
nShortURL is a NAVER Cloud Platform service that turns long and complex URLs into simple and short ones. The nShortURL service provides an API in RESTful form that shortens the entered URL to me2.do.
Common nShortURL settings
The following describes commonly used request and response formats in nShortURL APIs.
Request
The following describes the common request format.
API URL
The request API URL is as follows.
https://naveropenapi.apigw.ntruss.com/util/v1/shorturl
Request headers
The following describes the headers.
| Field | Required | Description |
|---|---|---|
x-ncp-apigw-api-key-id | Required | Client ID issued after application registration in NAVER Cloud Platform console |
x-ncp-apigw-api-key | Required | Client secret issued after application registration in NAVER Cloud Platform console |
Note
For information on how to register an application in the NAVER Cloud Platform console to obtain authentication information (client ID, client secret) required to use the API, see nShortURL User Guide.
In the console, make sure that the API you want to use after registering the application is selected by clicking the [Edit] button. If it is not selected, you will receive a 429 (Quota Exceed) error.
Response
The following describes the common response format.
Response status codes
The following describes the response status codes.
| HTTP status code | Code | Message | Description |
|---|---|---|---|
| 403 | 1403 | Invalid URL | Invalid request URL |
| 403 | 2403 | Forbidden URL | API usage permission error |
| 403 | 3403 | Unavailable URL | Request URL that does not exist or is not secure |
| 500 | 1500 | Internal Server Error | Internal server error
|
Note
For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.
nShortURL API
The following describes the APIs provided by the nShortURL service.
| API | Description |
|---|---|
| shorturl | Shorten URLs |
nShortURL related resources
NAVER Cloud Platform provides a variety of related resources to help users better understand nShortURL APIs.
- nShortURL API guides
- API overview: how to issue and check access key and secret key issued by NAVER Cloud Platform, how to generate the signature required for request headers
- API Gateway User Guide: how to check the API key required for the request header
- Common Ncloud response status codes: information on common response status codes of NAVER Cloud Platform used by the nShortURL service
- How to use the nShortURL service
- nShortURL User Guide: how to use nShortURL in the NAVER Cloud Platform console
- Ncloud use environment guide: guide for VPC and Classic environments and support availability
- Introduction to pricing, characteristics, and detailed features: the summary of pricing system, characteristics, and detailed features of nShortURL
- Latest service news: the latest news on nShortURL
- FAQ: frequently asked questions from nShortURL users
- Contact Us: Send direct inquiries in case of any unresolved questions that aren't answered by the user guides.
Was this article helpful?