短縮URLを作成

詳細

URLを短縮するためには、POSTメソッドで” SHORT URL”エンドポイントにリクエストする必要があります。

注意:「remote_url」に対して短縮URLが作成された場合、同じ「remote_url」に対して新しい短縮URLを作成するための後続のリクエストは、レスポンスで同じ「masked_url_id」が提供される結果となります。

エンドポイントURL: https://api.cpaas.symphony.rakuten.net/short-url/v1/url/

メソッド: POST

HTTP ヘッダー

パラメーター	要否	値
Authentication	必須	Type: Bearer Token: JWT Token
Accept	必須	application/json
Content-Type	必須	application/json; charset=UTF-8

リクエストボディスキーマ： application/json

パラメーター	要否	詳細/値
remote_url	必須	短縮する対象となるURL
name	任意	短縮URLの名前
description	任意	短縮URLの名前
valid_until_date	任意	有効期限の日付形式はyyyy-MM-dd HH:mm:ss 例：2024-06-15 13:21:45 デフォルト: 3日間最小: 5分最大: 30日間

サンプルリクエスト

{
  "masked_url": {
    "remote_url": "...Destination URL to mask behind a Short URL...",
    "name": "updated name"
    "description": "updated description"
    "valid_until_date": "yyyy-MM-dd HH:mm:ss"
  }
}

レスポンス:

成功した場合、APIコールはHTTP 200 OKとJSONドキュメントをレスポンスとして返します。失敗した場合のレスポンスについては、「エラーコード」セクションを参照してください。

パラメーター	詳細
result_code	結果コードを参照する
result_message	結果コードの詳細
masked_url_id	Remote URLを短縮した後のマスクされたURL ID
public_masked_url	マスクされたURL IDを含む最終的に公開されるURL

サンプルレスポンス

{
  "result_code": 0,
  "result_message": "Success",
  "masked_url_id": "...Generated Masked URL ID...",
  "public_masked_url": "https://<api.hostname>/<masked_url_id>"
}

短縮URLを作成

詳細​

詳細