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"
}