مرجع API

این مرجع همه‌ی اندپوینت‌هایی را فهرست می‌کند که یک یکپارچه‌سازی می‌تواند با کلید API فراخوانی کند. این فهرست از سند OpenAPI خودِ API ساخته می‌شود و فقط اندپوینت‌هایی را نگه می‌دارد که کلید API را می‌پذیرند. اندپوینت‌های خودِ پنل مشتری (ورود، حساب، تیم، صورت‌حساب) بخشی از API عمومی نیستند و اینجا نیامده‌اند. توضیح هر اندپوینت به انگلیسی است.

آدرس پایه و احراز هویتکپی پیوند بخش

همه‌ی درخواست‌ها به https://api.mail.land فرستاده می‌شوند و کلید شما را در سرآیند X-API-Key دارند:

curl https://api.mail.land/v1/transactional/send \
  -H "X-API-Key: ml_pet_..." \
  -H "Content-Type: application/json" \
  -d '{"from":{"email":"[email protected]"},"to":[{"email":"[email protected]"}],"subject":"Hello","htmlContent":"<p>Hello</p>"}'

کلیدهای ارسالِ محیط عملیاتی با ml_pet_ (تراکنشی) یا ml_pem_ (بازاریابی) شروع می‌شوند. کلیدهای sandbox با ml_set_ یا ml_sem_، کلیدهای دریافت با ml_pi_ و کلیدهای اعتبارسنجی با ml_pv_ شروع می‌شوند. کلیدهای API را ببینید.

بخش‌هاکپی پیوند بخش

خطاها و محدودیت‌ها برای همه‌ی اندپوینت‌ها برقرارند: کدهای خطا و محدودیت‌های نرخ را ببینید. تعهد سازگاری /v1 در سازگاری API آمده است.