ひとつのトークンで、すべてのエンドポイントへ。

トークンを生成する

AcelleMail のインストールにサインインし、プロフィールメニューを開いて API token をクリックします。値をコピーしてください — ユーザーごとに固有で、そのユーザーの権限に紐付きます。

# In your shell:
$ export ACELLE_TOKEN=paste-your-token-here
$ export ACELLE_BASE=https://your-acelle.example.com

トークンを検証する

/me を叩きます。トークンが有効ならユーザーレコードが返り、無効なら 401 が返ります — トークンとベース URL を確認してください。

$ curl $ACELLE_BASE/api/v1/me \
    -H "Authorization: Bearer $ACELLE_TOKEN"

{ "id": 1, "email": "you@…", "uid": "…" }

リストを作成する

リソースは POST で作成します。メーリングリストに必須のボディフィールドは name、from_email、from_name、subject と連絡先ブロックです。

$ curl -X POST $ACELLE_BASE/api/v1/lists \
    -H "Authorization: Bearer $ACELLE_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "name":       "Newsletter",
      "from_name":  "Acme",
      "from_email": "hi@acme.com",
      "subject":    "Welcome"
    }'

購読者を追加する

ステップ 3 で取得したリストの UID を使います。カスタムフィールドは、リストのフィールド設定に対応する大文字パラメータ（FIRST_NAME、LAST_NAME、…）として渡します。

$ curl -X POST $ACELLE_BASE/api/v1/subscribers \
    -H "Authorization: Bearer $ACELLE_TOKEN" \
    -d list_uid=$LIST_UID \
    -d EMAIL=alice@example.com \
    -d FIRST_NAME=Alice \
    -d tag=newsletter,beta

例: new_subscription のペイロード

POST /your-webhook-url
Content-Type: application/json
X-AcelleMail-Event: new_subscription
X-AcelleMail-Signature: sha256=…

{
  "event":       "new_subscription",
  "customer_id": 1234,
  "plan_id":     "extended-monthly",
  "fired_at":    "2026-05-06T12:34:56Z"
}

例: click のトラッキングペイロード

POST /your-webhook-url
Content-Type: application/json
X-AcelleMail-Event: click

{
  "event":         "click",
  "campaign_uid":  "abc123",
  "subscriber":    "alice@example.com",
  "url":           "https://acme.com/promo",
  "clicked_at":    "2026-05-06T12:34:56Z"
}

ページネーション

インデックス系エンドポイントは per_page（リソースに応じてデフォルト 10–25）と page を受け付けます。レスポンスは Laravel paginator の標準形 data[]、links、meta.current_page、meta.total を含みます。

レート制限

レート制限はお客様側の判断 — Laravel インストールの RouteServiceProvider で設定してください。標準ビルドでは自分のサーバーを叩く前提のため API スロットルは設定されていません。必要に応じて throttle:60,1 を追加してください。

バージョニング

現在のメジャーバージョンは v1 です。新規エンドポイントは自由に追加されますが、既存エンドポイントに対する互換性のない変更は v1 と並行して v2 としてリリースされます。クライアントを /api/v1/ に固定すれば安定動作します。