MailLandDocs
شروع کار

راه‌اندازی حساب

ایجاد حساب Mail.Land، تایید ایمیل و راه‌اندازی اولین فضای کاری

ایجاد حساب

ثبت‌نام

یک درخواست POST به endpoint ثبت‌نام ارسال کنید یا از طریق داشبورد در app.mail.land ثبت‌نام نمایید.

register.sh
curl -X POST https://api.mail.land/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "your-secure-password",
    "fullName": "Jane Doe",
    "companyName": "Acme Inc"
  }'

فیلدهای fullName و companyName اختیاری هستند اما توصیه می‌شوند. رمز عبور شما باید ۸ تا ۱۲۸ کاراکتر باشد و شامل حرف بزرگ، حرف کوچک، رقم و کاراکتر خاص باشد.

تایید ایمیل

پس از ثبت‌نام، MailLand یک کد تایید به ایمیل شما ارسال می‌کند. در پاسخ ثبت‌نام یک verificationTicket دریافت خواهید کرد:

Registration Response
{
  "requiresEmailVerification": true,
  "verificationTicket": "vt_abc123...",
  "maskedEmail": "y***@company.com"
}

کد دریافتی در صندوق ورودی خود را ارسال کنید:

verify-email.sh
curl -X POST https://api.mail.land/v1/auth/verify-email-ticket \
  -H "Content-Type: application/json" \
  -d '{
    "ticket": "vt_abc123...",
    "code": "482916"
  }'

اگر کد را دریافت نکردید، از طریق POST /v1/auth/resend-verification-ticket کد جدیدی درخواست دهید. بین درخواست‌های مجدد محدودیت زمانی وجود دارد و سقف روزانه‌ای نیز تعیین شده است.

ورود به سیستم

پس از تایید، وارد سیستم شوید تا توکن دسترسی خود را دریافت کنید:

login.sh
curl -X POST https://api.mail.land/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "your-secure-password"
  }'
Login Response
{
  "userId": "abc123def456",
  "email": "[email protected]",
  "fullName": "Jane Doe",
  "accessToken": "eyJhbGciOiJIUzI1NiIs...",
  "refreshToken": "rt_abc123...",
  "expiresAt": "2026-02-17T11:30:00Z",
  "tenantCount": 1,
  "activeTenantId": "k3m9x2p7qw4rtz",
  "activeTenantName": "Acme Inc"
}

اگر احراز هویت دو مرحله‌ای فعال باشد، پاسخ شامل requiresTwoFactor: true و یک twoFactorChallengeId به جای توکن‌ها خواهد بود.

فضاهای کاری (Tenants)

هر حساب MailLand حداقل یک فضای کاری (که Tenant نیز نامیده می‌شود) دارد. فضاهای کاری دامنه‌ها، اعتبارنامه‌ها، قالب‌ها و داده‌های ارسال شما را از هم جدا می‌کنند.

چه زمانی از چند فضای کاری استفاده کنیم

  • محیط‌های جداگانه: production در مقابل staging
  • محصولات جداگانه: اگر چندین اپلیکیشن دارید که ایمیل ارسال می‌کنند
  • مشتریان جداگانه: اگر آژانسی هستید که ایمیل چندین مشتری را مدیریت می‌کنید

تغییر فضای کاری

از توکن دسترسی خود برای جابجایی بین فضاهای کاری استفاده کنید. tenantId شناسهٔ رشته‌ای عمومی فضای کاری است: شناسه‌ها را از GET /v1/account/tenants دریافت کنید:

switch-tenant.sh
curl -X POST https://api.mail.land/v1/account/tenants/switch \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \
  -H "Content-Type: application/json" \
  -d '{
    "tenantId": "k3m9x2p7qw4rtz"
  }'

این عملیات یک توکن دسترسی جدید محدود به فضای کاری انتخابی بازمی‌گرداند.

احراز هویت دو مرحله‌ای

MailLand از احراز هویت دو مرحله‌ای مبتنی بر TOTP پشتیبانی می‌کند (سازگار با Google Authenticator، Authy، 1Password و غیره).

فعال‌سازی ۲FA

۱. POST /v1/auth/2fa/setup را فراخوانی کنید تا یک TOTP secret و QR code URI دریافت کنید ۲. QR code را با اپلیکیشن احراز هویت خود اسکن کنید ۳. راه‌اندازی را با ارسال یک کد معتبر از طریق POST /v1/auth/2fa/enable تایید کنید

پس از فعال‌سازی، هر بار ورود به سیستم نیازمند یک کد ۶ رقمی از اپلیکیشن احراز هویت شما خواهد بود.

کدهای بازیابی خود را در مکانی امن ذخیره کنید. در صورت از دست دادن دسترسی به اپلیکیشن احراز هویت، کدهای بازیابی تنها راه بازیابی دسترسی هستند.

احراز هویت API

MailLand از دو روش احراز هویت استفاده می‌کند:

توکن‌های Bearer (داشبورد و مدیریت حساب)

برای عملیات حساب (ورود، مدیریت فضای کاری، تنظیمات)، از توکن‌های JWT bearer در هدر Authorization استفاده کنید:

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

توکن‌ها پس از مدت زمان مشخص‌شده در expiresAt منقضی می‌شوند. از POST /v1/auth/refresh-token قبل از انقضا برای دریافت توکن جدید استفاده کنید.

کلیدهای API (عملیات ایمیل)

برای ارسال ایمیل، مدیریت دامنه و تمام فراخوانی‌های API عملیاتی، از کلیدهای API در هدر X-API-Key استفاده کنید:

X-API-Key: ml_pet_Ab3Kx9mN2pQ7rT4wL8yD...

کلیدهای API به یک فضای کاری محدود هستند و تا زمانی که تاریخ انقضا تعیین نکنید منقضی نمی‌شوند. برای جزئیات ایجاد و مدیریت اعتبارنامه‌ها به API Keys مراجعه کنید.

مراحل بعدی

در این صفحه