SSGHMail
ログイン

API ドキュメント

SGHMail REST API リファレンス

はじめに

SGHMail APIを使用すると、プログラムからメールの送受信、ドメイン管理、 Webhook設定などを行うことができます。

Base URL: https://api.sghmail.xyz/v1

認証

すべてのAPIリクエストにはAPIキーが必要です。ダッシュボードから取得できます。

curl -X GET https://api.sghmail.xyz/v1/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

エンドポイント

GET/v1/messages

受信メール一覧を取得します。

パラメータ:
  • limit - 取得件数（デフォルト: 20）
  • offset - オフセット
  • domain - ドメインでフィルタ
POST/v1/messages

メールを送信します。

{
  "to": "recipient@example.com",
  "from": "sender@yourdomain.sghmail.xyz",
  "subject": "Hello",
  "text": "Message body",
  "html": "<p>Message body</p>"
}
GET/v1/domains

登録済みドメイン一覧を取得します。

POST/v1/webhooks

Webhookエンドポイントを登録します。n8n連携に使用します。

DELETE/v1/webhooks/:id

Webhookエンドポイントを削除します。

n8n Webhook連携

SGHMailはn8nとの連携に最適化されています。メール受信時にn8nのWebhookノードにイベントを送信できます。

// Webhook ペイロード例
{
  "event": "email.received",
  "timestamp": "2025-01-15T10:30:00Z",
  "data": {
    "id": "msg_123456",
    "from": "sender@example.com",
    "to": "inbox@yourdomain.sghmail.xyz",
    "subject": "New inquiry",
    "text": "...",
    "html": "...",
    "attachments": []
  }
}

レート制限

Free プラン100 リクエスト/分
Pro プラン1,000 リクエスト/分
Business プラン10,000 リクエスト/分

APIキーを取得

ダッシュボードにログインしてAPIキーを発行できます。

ダッシュボードへ
← トップページに戻る
API ドキュメント | SGHMail