やること
- Settings → API keys からスコープ付きAPIキーを発行する。トークンは一度しか表示されないため、すぐにコピーしてください。
- SDKの1回の呼び出し、または1つの
curlコマンドで、1分以内にリンクを短縮する。 - 変更を伴うリクエストにはべき等キーを使い、リトライしてもリンクが二重に作成されないようにする。
Elido APIはREST + JSONで、OpenAPI 3.1 に準拠したドキュメントがあり、キーごとにレート制限されています。これをラップするTypeScript、Go、Python向けの公式SDKを提供しています。@elido/mcp-server のMCPサーバーは、同じ機能をAIエージェントに公開します。
APIキーを発行する
- Settings → API keys → Create key を開きます。
- 名前を付けます（使用するシステム名がおすすめです：
zapier、internal-billing、marketing-cli）。 - スコープを選びます。よく使う4つは次のとおりです：
links:read: リンクの一覧表示と確認。links:write: リンクの作成、更新、削除。analytics:read: クリックイベントの照会。webhooks:write: Webhookサブスクリプションの管理。
- Create をクリックします。キーは一度だけ表示されます。保存されるのはハッシュのみです。
キーを紛失した場合は、同じページで失効させ、新しいキーを発行してください。失効したキーは、全リージョンで60秒以内に拒否されるようになります。
TypeScript SDKでのクイックスタート
import { ElidoClient } from "@elido/sdk";
const client = new ElidoClient({ apiKey: process.env.ELIDO_API_KEY! });
const link = await client.links.create({
destination: "https://acme.com/spring-sale",
slug: "spring-2026",
});
console.log(link.short_url);
GoおよびPython SDKも同じ形式です。詳細なリファレンスは /api にあります。
curlでのクイックスタート
curl -X POST https://api.elido.app/v1/links \
-H "Authorization: Bearer $ELIDO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"destination":"https://acme.com/spring-sale","slug":"spring-2026"}'
レート制限
無料プランは、キーあたり毎分60リクエストです。Proは毎分600、Businessは毎分6000です。バーストは定常制限の2倍で、レスポンスヘッダー X-RateLimit-Remaining で現在の残りを確認できます。
制限に達すると、APIは Retry-After を設定した429を返します。SDKはデフォルトで指数バックオフによるリトライを実装しています。アプリ側で独自のリトライポリシーを持つ場合は、無効にしてください。
べき等性
変更を伴うエンドポイントは Idempotency-Key ヘッダーを受け付けます。書き込みごとにUUIDを渡すと、レスポンスを24時間キャッシュするため、リトライ（ネットワークエラーや判断のつかないタイムアウト）で二重に作成されることはありません。
SDKはこのヘッダーを自動的に付与します。curlを直接使う場合は、クライアント側でキーを生成し、リトライのたびに含めてください。
Webhook
ポーリングの代わりにリアルタイム通知が必要な場合は、Settings → Webhooks でWebhookを設定してください。link.created、link.updated、domain.verified などのイベントを、HMAC署名付きで配信します。クリックごとのイベントはまだ利用できません。一覧は Webhookガイド を参照してください。