APIドキュメント
MailPass APIを使用してメールサービスを統合しましょう。
Base URL
https://dev.mailpass.im/api/v1
認証
すべてのAPIリクエストには、AuthorizationヘッダーにAPIキーを含める必要があります。
Authorization: Bearer YOUR_API_KEY
APIキーは設定 > APIキーから作成できます。
OTP API
メール認証コードの送信および検証用API
POST /otp/send
POST /otp/verify
購読者API
購読者およびリスト管理用API
POST /subscribers
GET /subscribers
キャンペーンAPI
メールキャンペーンの作成および送信用API
POST /campaigns
POST /campaigns/:id/send
Mail Send API
トランザクションメール送信用API(単件/バッチ)
POST /mail/send
POST /mail/send-batch
Webhook
イベント通知を受け取るためのWebhook設定
email.opened
email.clicked
バウンスAPI
メールバウンスの処理および照会用API
POST /bounces
GET /bounces
レスポンス形式
すべてのAPIレスポンスはJSON形式で返されます。
成功レスポンス
{
"success": true,
"data": { ... }
}
エラーレスポンス
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "The email field is required."
}
}
Rate Limits
APIリクエストは1分あたり60回に制限されています。Rate limit超過時は429ステータスコードが返されます。