پرش به مستندات
Ruby

gem برای Ruby

کلاینت رسمی Ruby برای API OpenEmail. بدون وابستگی زمان اجرا، و برای هر اندپوینت یک متد.

چیست

یک gem روی کل API (ارسال، قالب‌ها، ردیابی، رشته‌ها، پیش‌نویس‌ها، برچسب‌ها، مخاطبان، گروه‌های مخاطب، فرم‌های ثبت‌نام، ارسال‌های گروهی، دامنه‌ها، قواعد، وب‌هوک‌ها، تقویم، تنظیمات، نقش‌ها، اعضا، توقیف‌ها، فایل‌ها و صندوق‌های یک‌بارمصرف) با یک متد برای هر متد SDK TypeScript با همان نام به شکل snake_case، یک کلاس خطا برای هر نوع رد شدن، تلاش‌های دوباره‌ای که نمی‌توانند یک ارسال را تکراری کنند، و یک وارسی‌کنندهٔ امضای وب‌هوک. فقط به Ruby 3.2 یا بالاتر نیاز دارد و نه چیز دیگری، یک کلاینت را می‌توان بی‌خطر میان تردها به اشتراک گذاشت، و پس از fork هم سالم کار می‌کند.

bundle add openemail
send_email.rb
require "openemail" OpenEmail.init(api_key: ENV.fetch("OPENEMAIL_API_KEY")) OpenEmail.emails.send(  from: "Acme Billing <[email protected]>",  to: "[email protected]",  subject: "Your September invoice",  html: "<p>Invoice attached.</p>")

از کجا ادامه دهید

همان API کلاینت‌های دیگر را می‌پوشاند

هر چیزی که اینجاست همان سطحی است که مرجع API مستندش می‌کند و SDK TypeScript آن را می‌پوشاند، پس برای اینکه یک اندپوینت چه می‌کند مرجع API را بخوانید و برای اینکه چگونه از Ruby صدایش بزنید این را. هر متد TypeScript یک همتای Ruby دارد، و بررسی همخوانیِ gem هر دو را با آرگومان‌های یکسان اجرا می‌کند و شکست می‌خورد مگر آنکه بایت به بایت همان درخواست را بفرستند.