クイックスタート
curl、JavaScript、Pythonのいずれかを使って、APIで最初の短縮リンクを2分で作成します。
2026年8月13日更新
ゼロから動く短縮リンクまで2分です。links:writeスコープを持つワークスペースのAPIキーが
必要になります。ダッシュボードの設定 → APIキーで作成してください(完全な値は一度だけ
表示されます)。
以下のスニペットはベースURLとキーを環境変数から読むので、同じコマンドが本番でもローカルの 環境でも動きます。
export LINKPROFIT_API_BASE="https://api.linkprofit.com/v1"
export LINKPROFIT_API_KEY="lp_live_…your key…"
1. リンクを作成する
curl -s -X POST "$LINKPROFIT_API_BASE/links" \
-H "Authorization: Bearer $LINKPROFIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url": "https://example.com/summer-sale", "title": "Summer sale"}'
レスポンスは、リンクオブジェクトの全体です。
{
"data": {
"id": "lnk_2f8k1mVq3xZcW9yTb4Nda",
"short_url": "https://go.your-brand.com/x7f2q1z",
"domain": "go.your-brand.com",
"slug": "x7f2q1z",
"url": "https://example.com/summer-sale",
"title": "Summer sale",
"has_password": false,
"public_stats": false,
"created_at": "2026-08-13T10:00:00.000Z"
}
}
domain_idを指定しない場合、リンクは既定のドメインに置かれます。slugを指定しない場合
は空いているコードが生成されます。リンクモデルのすべてのオプション——ターゲティング、AB
テストの分割、有効期限、パスワード、UTM、ピクセル——は同じリクエストで受け付けます。詳しく
はリファレンスをご覧ください。
2. リンクを一覧する
curl -s "$LINKPROFIT_API_BASE/links?limit=10" \
-H "Authorization: Bearer $LINKPROFIT_API_KEY"
一覧はカーソルでページ送りされます。
pagination.next_cursorがnullになるまでたどってください。
3. サマリーを取得する
curl -s "$LINKPROFIT_API_BASE/analytics/summary" \
-H "Authorization: Bearer $LINKPROFIT_API_KEY"
analytics:readスコープが必要です。日付を指定しない場合は直近30日が表示されます。
JavaScriptでの同じ処理
const base = process.env.LINKPROFIT_API_BASE;
const key = process.env.LINKPROFIT_API_KEY;
const response = await fetch(`${base}/links`, {
method: "POST",
headers: {
Authorization: `Bearer ${key}`,
"Content-Type": "application/json",
},
body: JSON.stringify({ url: "https://example.com/summer-sale" }),
});
if (!response.ok) {
const { error } = await response.json();
throw new Error(`${error.code}: ${error.message}`);
}
const { data } = await response.json();
console.log(data.short_url);
Pythonでの同じ処理
import os
import requests
base = os.environ["LINKPROFIT_API_BASE"]
key = os.environ["LINKPROFIT_API_KEY"]
response = requests.post(
f"{base}/links",
headers={"Authorization": f"Bearer {key}"},
json={"url": "https://example.com/summer-sale"},
timeout=10,
)
response.raise_for_status()
print(response.json()["data"]["short_url"])
再試行しても安全な作成
どの更新系リクエストにもIdempotency-Keyヘッダーを付けられます。同じキーでリクエストを
繰り返すと、2本目のリンクを作るのではなく保存済みのレスポンスが返るので、ネットワークの
タイムアウト後でも安全に再試行できます。
curl -s -X POST "$LINKPROFIT_API_BASE/links" \
-H "Authorization: Bearer $LINKPROFIT_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: order-42-launch" \
-d '{"url": "https://example.com/launch"}'
キーは24時間保存されます。同じキーで本文が異なる場合は409 conflictが返ります。