added
مدل کلید استقرار، جایی که توکن حامل همان پروژه است. این همان چیزی است که CLI و اکشن گیت‌هاب هر دو روی آن اجرا می‌شوند.
api v1 · جاری
گزارش تغییرات API.
هیچ چیزی حذف نشده است.
/v1 همیشه فقط موارد جدید اضافه می‌کند. نقاط پایانی و فیلدهای پاسخ جدید در همان پیشوند قرار می‌گیرند و فیلدی که قبلاً پردازش کرده‌اید، هرگز تغییر شکل نمی‌دهد یا حذف نمی‌شود. یک تغییر سازگاری‌شکن تحت یک پیشوند نسخه جدید منتشر می‌شود که رزرو شده و هنوز خالی است.
v1/api/v1
تنها پیشوند در حال استفاده
تنها پیشوند در حال استفاده
5 انتشار
11 تغییر، بدون هیچ تغییر سازگاری‌شکن
ساختار گزارش تغییرات
یک پیشوند نسخه، بدون حذفیات.
سه مورد از این چهار مورد، ویژگی‌های خودِ این گزارش هستند. مورد چهارم، اندازه کاتالوگ وب‌هوک‌هایی است که API ارائه می‌دهد.
5
انتشارها روی /v1، همه آن‌ها افزاینده
1
پیشوند نسخه در حال استفاده. بعدی رزرو شده و خالی است
0
تغییرات سازگاری‌شکن از زمان عرضه API
12
رویدادهای وب‌هوک امضاشده. منبع: App\Enums\WebhookEvent
تاریخ‌گذاری بر اساس انتشار، نه بر اساس semver
برای جابجایی از کلیدهای جهت‌دار استفاده کنید
2026-07-08
تحویل CDN، استفاده و محیط آزمایشی
July 8, 2026 · 4 تغییر
05 / 05
added
/v1/incontext/translations، /screenshots و /suggest ویرایشگر بصری را هدایت می‌کنند، با CORS محدود به همان پیشوند و هیچ چیز دیگر.
POST /v1/incontext/session یک کلید قابل انتشار و یک Origin را با یک توکن نشست محدود مبادله می‌کند.
improved
یک خروجی دوزبانه اکنون مواردی را که نتوانسته بازگرداند گزارش می‌دهد، به جای اینکه متن منبع را به صورت خاموش جایگزین کند. فیلدهای موجود بدون تغییر باقی می‌مانند، که هدف اصلی قرار دادن آن در هدر است.
GET /v1/pull هدرهای پاسخ X-Skipped-Keys و X-Missing-Source-Keys را دریافت کرد.
added
به علاوه /v1/glossary/import، /export و /extract، بنابراین پایگاه اصطلاحات میتواند بدون باز کردن کنسول جابجا شود.
CRUD کامل پایگاه اصطلاحات از طریق API: GET، POST، PUT و DELETE روی /v1/glossary.
added
یافتهها در ردیفهای ترجمهای که از قبل دریافت می‌کنید ظاهر می‌شوند، بنابراین نیازی به نظارت جدید نیست.
POST /v1/qa/run یک بررسی کیفیت هوشمند را فعال کرده و شناسه اجرا را برمی‌گرداند.
added
برای هر نقطه پایانی اشتراک بگیرید. فهرست در App\Enums\WebhookEvent قرار دارد که امروز دوازده حالت دارد؛ به جای این خط، شمارش enum را انجام دهید.
وب‌هوک‌های امضاشده رویدادهای کلید، ترجمه، زبان، واژه‌نامه و QA را همراه با جفت دسته اصلی ارسال می‌کنند.
improved
تحویل شامل یک شمارنده و حداکثر بیست نمونه است، نه یک فراخوانی برای هر ردیف تغییر یافته. گزارشهای تحویل هر تلاش را همراه با زمان تلاش بعدی ثبت می‌کنند.
رویدادهای پرتکرار مانند translation.updated در یک پنجره زمانی ادغام شده و به صورت یک تحویل ارسال می‌شوند، بنابراین ویرایش انبوه هیچ‌گاه نقطه پایانی را اشباع نمی‌کند.
added
این پاسخ یک ETag و کش کوتاه‌مدت برمی‌گرداند و If-None-Match را با کد 304 رعایت می‌کند. نسخه ثابت تحت /v{n} بر اساس محتوا آدرس‌دهی شده و برای یک سال در کش ذخیره می‌شود.
یک GET عمومی و قابل ذخیره در حافظه نهایی لبه، /v1/cdn/{project}/{locale} رشته‌های منتشر شده شما را ارائه می‌دهد.
added
آن را در CI با POST /v1/cdn/publish فعال کنید و خواندن‌ها را با یک کلید مخصوص فقط-خواندنی در هدر X-Transglot-Cdn-Key مجاز سازید. قرار دادن آن پشت CDN شخصی شما ایمن است.
انتشار، ترجمه‌های فعلی را به یک نسخه ثابت جدید ارتقا می‌دهد، چه به صورت دستی و چه با هر بار push.
added
بدنه درخواست‌ها ذخیره نمی‌شود. این تنها یک شمارنده است و چیز دیگری نیست.
هر فراخوانی احراز هویت شده /v1 به ازای هر توکن در روز شمارش شده و در مرکز استقرار نمایش داده می‌شود.
improved
پروژه، pull، دسته‌ها و خروجی واژه‌نامه. هیچ شکل درخواست یا پاسخی برای کار کردن آن تغییر نکرد.
مرکز استقرار دارای یک محیط آزمایشی API شد که نقاط پایانی فقط-خواندنی را به صورت زنده روی پروژه شما اجرا می‌کند.
ثبت منسوخ‌سازی
هیچ چیز حذف نخواهد شد.
یک ردیف برای هر سطح منتشر شده، همراه با نسخه‌ای که آن را عرضه کرده است. ستون آخر موردی است که باید زیر نظر داشته باشید: حذف در آنجا با تاریخی بسیار قبل از وقوع واقعی نمایش داده می‌شود.
| سطح | منتشرشده | وضعیت | تاریخ حذف |
|---|---|---|---|
GET /v1/project · /pull · POST /push · /translate · GET /batches | April 2, 2026 | فعلی | بدون زمان‌بندی |
POST /v1/incontext/session · /translations · /screenshots · /suggest | May 20, 2026 | فعلی | بدون زمان‌بندی |
GET, POST, PUT, DELETE /v1/glossary · /import · /export · /extract | June 12, 2026 | فعلی | بدون زمان‌بندی |
POST /v1/qa/run | June 12, 2026 | فعلی | بدون زمان‌بندی |
Signed webhook events, twelve typed cases | June 30, 2026 | فعلی | بدون زمان‌بندی |
GET /v1/cdn/{project}/{locale} · POST /v1/cdn/publish | July 8, 2026 | فعلی | بدون زمان‌بندی |
هیچ ردیفی از این جدول هرگز حذف نمی‌شود. اگر یک سطح بازنشسته شود، ردیف خود را حفظ کرده و تاریخی می‌گیرد، زیرا امکان برنامه‌ریزی برای حذف، هدف اصلی انتشار آن است.
تعهد سازگاری
سه قانون که می‌توانید روی آن بسازید.
افزایشی
نقاط پایانی جدید و فیلدهای پاسخ جدید در داخل /v1 عرضه می‌شوند. فیلدی که قبلاً پردازش کرده‌اید، تغییر شکل نمی‌دهد و ناپدید نمی‌شود.
پیشوند جدید
یک تغییر ساختاری تحت یک پیشوند نسخه جدید عرضه می‌شود نه در داخل این نسخه. آن پیشوند رزرو شده و استفاده‌نشده است و هر انتشار بالاتر روی v1 قرار گرفته است.
سربرگ‌های شفاف
وقتی یک درخواست نمی‌تواند چیزی را به‌طور کامل بازگرداند، در سربرگ اعلام می‌کند. X-Skipped-Keys و X-Missing-Source-Keys اضافه شدند تا بدنه پاسخ زیر پای شما تغییر نکند.
سوالات متداول
آنچه توسعه‌دهندگان درباره نسخه‌بندی و منسوخ‌سازی API می‌پرسند.
Is the Transglot API versioned?
بله، از طریق پیشوند URL. هر آنچه تا کنون منتشر شده تحت /v1 قرار دارد که تنها پیشوند مورد استفاده است. هیچ هدر نسخه‌ای، تاریخ تثبیت‌شده یا تنظیماتی وجود ندارد.
آیا به‌روزرسانی‌ها هرگز یکپارچگی من را مختل خواهند کرد؟
نه در داخل /v1. نقاط پایانی جدید و فیلدهای پاسخ جدید اضافه می‌شوند، اما فیلدی که قبلاً تجزیه کرده‌اید تغییر شکل نمی‌دهد و حذف نمی‌شود. اگر تغییری نتواند به صورت افزایشی اعمال شود، تحت یک پیشوند جدید قرار می‌گیرد و قدیمی همچنان کار می‌کند.
آیا چیزی منسوخ یا حذف شده است؟
هیچ چیز، و ثبت بالا سطر به سطر این را تأیید می‌کند. هر سطح منتشرشده با نسخه‌ای که آن را عرضه کرده و ستونی برای حذف فهرست شده که در حال حاضر برای همه «برنامه‌ریزی نشده» است.
برای حذف چقدر اطلاع داده می‌شود؟
حذف شدن با تاریخی مشخص در آن ثبت ظاهر می‌شود، مدت‌ها قبل از وقوع، و سطر پس از آن به جای ناپدید شدن در جدول باقی می‌ماند. داشتن تاریخی قابل برنامه‌ریزی، هدف اصلی انتشار آن است.
چگونه بدانم چه زمانی چیزی جدید عرضه می‌شود؟
هر نسخه در این صفحه تاریخ‌گذاری شده است. گزارش تغییرات محصول سایر موارد عرضه‌شده را پوشش می‌دهد و کنسول هنگامی که مطلبی خوانده نشده باشد نشانگری نمایش می‌دهد.
چرا گزارش تغییرات جداگانه‌ای برای API وجود دارد؟
زیرا API تعهد سازگاری دارد که انتشار محصول ندارد. توسعه‌دهنده‌ای که بررسی می‌کند آیا یکپارچگی هنوز کار می‌کند یا خیر، نباید مجبور شود برای یافتن پاسخ از میان کارهای ویژگی عبور کند.
چگونه API را به طرح خود اضافه کنم؟
توکن حامل از طرح Starter با ماهی ۱۹ دلار شروع می‌شود. طرح رایگان کنسول را پوشش می‌دهد اما نمی‌تواند توکن صادر کند و CLI، اکشن گیت‌هاب، وب‌هوک‌ها و MCP همگی پشت همان توکن قرار دارند.
مرجع خودِ نقاط پایانی کجاست؟
در صفحهٔ API: احراز هویت، نقاط پایانی، محدودیت نرخ، قالب‌های فایل و فهرست وب‌هوک. این صفحه فقط سوابق تغییرات و زمان آن‌ها را ثبت می‌کند.
با ابزارهایی که هم‌اکنون استفاده می‌کنید سازگار است
41 اتصال‌دهنده، از پیش ساخته‌شده.
قرارداد همان محصول است
ساخت بر پایهٔ API که ثابت می‌ماند.
API در پلن Starter و بالاتر موجود است. طرح رایگان ۰ دلار است با ۱۰۰٬۰۰۰ واژه برای شروع (۲۵٬۰۰۰ هنگام ثبت‌نام، ۷۵٬۰۰۰ پس از تأیید تلفنی)، ماهانه ۱۰٬۰۰۰ واژه بعد از آن، و بدون دسترسی به API یا وب‌هوک.