shorturl

Classic/VPC 환경에서 이용 가능합니다.

길고 복잡한 URL을 me2.do 형식의 짧은 URL로 변환합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

요청 헤더

nShortURL API에서 공통으로 사용하는 헤더에 대한 정보는 nShortURL 공통 헤더를 참조해 주십시오.

요청 쿼리 파라미터

파라미터에 대한 설명은 다음과 같습니다.

요청 예시

요청 예시는 다음과 같습니다.

• GET

curl --location --request GET 'https://naveropenapi.apigw.ntruss.com/util/v1/shorturl
?url={url} \
--header 'X-NCP-APIGW-API-KEY-ID: {앱 등록 시 발급받은 Client ID}' \
--header 'X-NCP-APIGW-API-KEY: {앱 등록 시 발급 받은 Client Secret}'

• POST - Content-Type: application/x-www-form-urlencoded 방식

curl --location --request POST 'https://naveropenapi.apigw.ntruss.com/util/v1/shorturl' \
--header 'X-NCP-APIGW-API-KEY-ID: {앱 등록 시 발급받은 Client ID}' \
--header 'X-NCP-APIGW-API-KEY: {앱 등록 시 발급 받은 Client Secret}' \
--header 'Content-Type: application/x-www-form-urlencoded; charset=UTF-8' \
--data-urlencode 'url={url}'

• POST - Content-Type: application/json 방식

curl --location --request POST 'https://naveropenapi.apigw.ntruss.com/util/v1/shorturl' \
--header 'X-NCP-APIGW-API-KEY-ID: {앱 등록 시 발급받은 Client ID}' \
--header 'X-NCP-APIGW-API-KEY: {앱 등록 시 발급 받은 Client Secret}' \
--header 'Content-Type: application/json' \
--data '{
    "url": "{url}"
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

응답 상태 코드

nShortURL API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 nShortURL 공통 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

• URL 단축에 성공했을 때

{
    "result": {
        "url": "https://me2.do/Ffe****",
        "hash": "Ffe0DVRP",
        "orgUrl": "{orgURL}"
    },
    "message": "ok",
    "code": "200"
}

• URL 단축에 실패했을 때

{
    "timestamp": "2024-08-19T00:26:00Z",
    "status": 403,
    "error": "FORBIDDEN",
    "message": "UNAVAILABLE_URL",
    "code": "3403"
}