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

SDK

یک کلاینت TypeScript تایپ‌شده برای API اوپن‌ایمیل (OpenEmail). بدون هیچ وابستگی، و برای هر اندپوینت یک متد.

این چیست

یک پکیج روی کل API (ارسال، قالب‌ها، ردیابی، رشته‌ها، پیش‌نویس‌ها، برچسب‌ها، مخاطبان، گروه‌های مخاطب، دامنه‌ها، قواعد، وبهوک‌ها، تقویم، تنظیمات، نقش‌ها، اعضا و صندوق‌های یک‌بارمصرف) با تایپ برای هر درخواست و پاسخ، دو کلاس خطا، تلاش‌های دوباره‌ای که نمی‌توانند یک ارسال را تکراری کنند، و یک راستی‌آزمای امضای وبهوک. بدون هیچ وابستگی زمان اجرا، ESM و CommonJS، روی Node 20+، Bun، Deno و Cloudflare Workers. کلید فضای کاری را حمل می‌کند، پس روی سرور اجرا می‌شود، و صندوق‌های یک‌بارمصرف تنها بخشی‌اند که در مرورگر هم اجرا می‌شوند.

pnpm add @openemail/sdk
send-email.ts
import { init, openemail } from '@openemail/sdk' init({ apiKey: process.env.OPENEMAIL_API_KEY }) await openemail.emails.send({  from: 'Acme Billing <[email protected]>',  to: '[email protected]',  subject: 'Your September invoice',  html: '<p>Invoice attached.</p>',})

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

این، همان API‌ای را می‌پوشاند که در زبانهٔ پیش از این است

هر چیزی که اینجاست همان سطحی است که مرجع API مستندش می‌کند، پس برای اینکه یک اندپوینت چه می‌کند آن را بخوانید و برای اینکه چگونه صدایش بزنید این را. برای هر عملیات مستندشده یک متد هست، و بررسی همخوانی این پکیج سند OpenAPI را می‌خواند تا همین را ثابت کند.