リンク作成
このAPIは短縮URLを生成します。
複数のリンクを一度に作成するには、「一括作成」APIをご利用ください。
また、ダッシュボードの「大量リンク作成」メニューからも素早く作成できます。
すべての短縮リンクにはQRコードが自動生成されます。
生成されたQRコードは、以下の形式のURLで確認できます：
vvd.bz/[linkId]/qr
QRコードのサイズを調整するには、size パラメータを追加してください。
例：vvd.bz/[linkId]/qr?size=200 → 200ピクセルのQRコードが生成されます。
Http Header
POST /api/link/v2/create
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: application/json
User-agent: {Your User-agent}
Accept-Language: en
Request
{
"url": "https://www.facebook.com/vivoldi365",
"domain": "https://vvd.bz"
}| フィールド | フィールドの説明 | 説明 | 必須 | タイプ |
|---|---|---|---|---|
| url | 長いURL | 生成された短いリンクをクリックしたときに移動する長いURLです。 最大3,000 bytesまで設定できます。 | string | |
| domain | ドメイン | 値が空の場合、自動的にvvd.bzドメインに設定されます。 “「https://”値を含めて設定する必要があり、“brandLinkId”オプションが“Y”の場合、ドメインは“https://vvd.im”に設定してください。 あなたが所有したドメインをVivoldiと連動した場合、そのドメインを設定します。 例： https://vvd.bz | string | |
| redirectType | Redirect方法 | 短いURLから長いURLに移動する方法を設定します。 HTTPのステータス応答コードとして200、301、302のいずれかを選択することができます。デフォルト値: 302 Redirect方法の詳細は「用語まとめ」ページで確認してください。 | int | |
| grpIdx | グループID | グループIDを設定すると、そのグループにリンクが生成されます。 グループIDを確認するには、「グループリスト」APIを呼び出して確認する必要があります。 | int | |
| brandLinkId | ブランドリンクID | 値を指定すると、そのIDでリンクが生成されます。 (ブランドリンクが設定されている場合、ドメインはvvd.bzではなくvvd.imです) 値が空の場合、リンクIDは自動的に生成されます。 | string | |
| ttl | リンクタイトル | 値が空の場合、長いURLのウェブページのタイトルとして保存されます。 値が空の場合、長いURLにアクセスしてHTMLの解析作業が行われるため、API呼び出し後の応答速度が遅い場合は、タイトルを設定してください。 | string | |
| description | Metaの内容 | 「redirectType」の値が「200」のとき、ページのメタタグであるdescriptionを設定することができます。 「redirectType」の値が「301」、「302」の時はこの値は無視されます。 | string | |
| metaImg | メタ画像 | リダイレクトタイプが「200」の場合のみ、メタ画像タグを設定できます。 メタ画像の値は、URL形式で「https://」で始まる必要があります。 リダイレクトタイプが「301」または「302」の場合、値は無視されます。 | string | |
| memo | メモ | ユーザーに公開されず、管理に必要な付加情報を設定することができます。 | string | |
| notfSubscYn | プッシュリンク | 値がYの場合、生成されたリンクをクリックすると、長いリンクに移動する前にWebプッシュ通知ポップアップが表示され、ユーザーがプッシュ通知を許可した場合、許可したすべてのユーザーにプッシュメッセージを送信することができます。 通知ポップアップに同意しないか、キャンセルする場合、すぐに元の長いURLに移動します。 値を入力しない場合、デフォルト値はNです。 プッシュサブスクリプションリンクの詳細については、「Webプッシュ機能紹介」ページをご覧ください。 | Y or N | |
| pushNotifyYn | クリック数プッシュ通知 | 値がYの場合、「設定 -> 環境設定」ページのリンク設定で設定されたリンククリック数に達するたびに、Vivoldiアプリがインストールされたモバイルデバイスにクリック数プッシュ通知を受け取ることができます。 この機能はパーソナルプランから利用できます。 | Y or N | |
| mailNotifyYn | クリック数メール通知 | 値がYの場合、「設定 -> 環境設定」ページのリンク設定で設定されたリンククリック数に達するたびに、Vivoldiに登録されたメールでクリック数情報を受け取ることができます。 この機能はパーソナルプランから利用できます。 | Y or N | |
| delYmd | リンク削除日 | 設定した日付が過ぎると、リンクがシステムによって自動的に削除されます。 削除周期: 1時間ごと はい: 2025-12-31 | Date |
Response
{
"code": 0,
"message": "",
"result": "https://vvd.bz/jH3d"
}
| フィールド | 説明 | タイプ |
|---|---|---|
| code | 応答コード (0:成功) | int |
| message | 応答メッセージ、応答コードが0でない場合、関連メッセージが返されます。 | string |
| result | 応答値 (短縮されたリンク) | string |