مستندات API مترجم دوگفت

معرفی سرویس

این API به شما اجازه می‌دهد تا متون خود را به صورت کلمه به کلمه ترجمه کنید. سرویس از دو زبان فارسی و انگلیسی پشتیبانی می‌کند. تمامی درخواست‌ها باید به صورت GET ارسال شوند و پاسخ‌ها به فرمت JSON بازگردانده می‌شوند.

آدرس پایه (Base URL):
http://runhub.ir/dic/api/

پارامترهای درخواست

GET

برای ارسال درخواست، باید پارامترهای زیر را به صورت Query String در انتهای URL قرار دهید:

نام پارامتر	نوع	اجباری؟	توضیحات
text	String	بله	متنی که می‌خواهید ترجمه شود.
lang	String	خیر	جهت ترجمه. مقدار پیش‌فرض en2fa است. مقادیر مجاز: en2fa (انگلیسی به فارسی) یا fa2en (فارسی به انگلیسی).

نمونه درخواست

مثال زیر یک درخواست ساده برای ترجمه کلمه "Hello" به فارسی را نشان می‌دهد:

آدرس URL:

http://runhub.ir/dic/api/?text=Hello&lang=en2fa

کد جاوااسکریپت (JavaScript):

fetch('http://runhub.ir/dic/api/?text=Hello World&lang=en2fa')
  .then(response => response.json())
  .then(data => {
      console.log(data.translated_text);
  })
  .catch(error => console.error('Error:', error));

فرمت پاسخ (Response)

پاسخ سرور همیشه به فرمت JSON است و شامل فیلدهای زیر می‌باشد:

فیلد	توضیحات
status	وضعیت پاسخ (success یا error).
original_text	متن اصلی ارسال شده توسط کاربر.
translated_text	متن ترجمه شده.
lang	جهت ترجمه انجام شده.
message	پیام خطا (فقط در صورت بروز خطا وجود دارد).

نمونه پاسخ موفق:

{
    "status": "success",
    "original_text": "Hello",
    "translated_text": "سلام",
    "lang": "en2fa"
}

نمونه پاسخ خطا:

{
    "status": "error",
    "message": "متن ورودی خالی است."
}