دليل تطوير واجهة واجهة برمجة التطبيقات المفتوحة

يجب أن تتضمن جميع طلبات الواجهة معلمات المصادقة التالية في عنوان URL:

رابط الطلب: /Code.ashx?op=code&app=api&token=YOUR_TOKEN&type=0

طريقة الاستدعاء: POST

تكتب المعلمات بشكل موحد في عنوان URL، ويتم تمرير بيانات الصورة عبر جسم POST (يدعم الأجزاء المتعددة تدفق الملف، حقل النموذج، أو النص العادي).

2.1 أدخل الصورة التي سيتم التعرف عليها (اختر واحدة من ثلاث صورة)

2.2 وضع النواة والتحكم في المحرك

2.3 قواعد التنسيق والتخطيط (اختياري)

المعلمات التالية تمر بالقيم 1 شغل المعالجة المقابلة، القيمة 0 ليس على الموضوع.
إذا لم تكن هناك حاجة محددة، ينصح بعدم تمريرها، وترك القرار للنظام التالي:

2.4 وصف قيمة الإرجاع (JSON)

ترجع واجهة التعرف صيغة JSON قياسية. القيمة هي null يتم حذف الحقل تلقائيا.

الحقول العليا

result الكائن الفرعي – نتيجة نصية

result الكائن الفرعي - بيانات 🗺️ تحديد المواقع الإحداثية

تحتوي الحقول التالية على الموقع الدقيق لكل كتلة نصية على الصورة الأصلية، مناسبة لسيناريوهات مثل تمييز التراكبات، استخراج المناطق، وغيرها.

verticalText هيكل كائنات TextCellInfo

[
  {
    "words": "المحتوى النصي الذي يتم التعرف عليه",
    "trans": "نتائج الترجمة (إن وجدت)",
    "pageIndex": 0,
    "location": {
      "left": 120.0,
      "top": 45.0,
      "width": 230.0,
      "height": 28.0
    }
  },
  ...
]

result الكائن الفرعي - تحميل الملف

files هيكل كائن DownLoadInfo في بنية كائن DownLoadInfo

state تعداد الولايات

مثال قديم

✅ الاستجابة الناجحة (مع بيانات الإحداثيات):

{
  "ocrType": 0,
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "processId": 3,
  "processName": "OCR-Node-01",
  "state": 2,
  "result": {
    "autoText": "النص الكامل بعد الدمج الذكي",
    "spiltText": "النص الأصلي مقسم إلى فقرات",
    "verticalText": "[{\"words\":\"مرحبا\",\"location\":{\"left\":10,\"top\":20,\"width\":80,\"height\":22}}]",
    "resultType": 0,
    "lang": "chi_sim"
  }
}

❌ استجابة الخطأ/الحد:

{
  "ocrType": 0,
  "processName": "نصائح",
  "result": {
    "spiltText": "تم استنفاد حصة API اليوم، يرجى إعادة شحنها والاستمرار في استخدامها！",
    "autoText": "تم استنفاد حصة API اليوم، يرجى إعادة شحنها والاستمرار في استخدامها！"
  },
  "id": 1
}

رابط الطلب: /Code.ashx?op=idcode&app=api&token=YOUR_TOKEN

طريقة الاستدعاء: POST

الوظيفة: تم إرجاعه وفقا لواجهة التعرف id استعلام نتائج المعالجة غير المتزامنة. عندما تعود واجهة التعرف state=0(قيد الانتظار)، يمكنك استخدام هذه الواجهة للاستطلاع للحصول على النتيجة النهائية.

مثال قديم

✅ استجابة ناجحة:

[
  {
    "ocrType": 0,
    "id": "a1b2c3d4-...",
    "processName": "OCR-Node-01",
    "state": 2,
    "result": {
      "autoText": "تحديد النص الناتج",
      "spiltText": "النص المقسم",
      "resultType": 0
    }
  }
]

❌ رد فاشل (معرف غير موجود أو انتهاء صلاحية النتيجة):

no

يعيد نصا عاديا no يشير إلى أنه لم يتم العثور على نتيجة لذلك المعرف، والذي قد يكون معرفا الخطأ أو النتيجة انتهت صلاحيتها وتم إزالتها.

رابط الطلب: /Code.ashx?op=imgUpload&app=api&token=YOUR_TOKEN

طريقة الاستدعاء: POST (multipart/form-data)

الوظيفة: قم برفع صورة إلى صفحة الصور المجانية وإرجاع رابط مباشر يمكن الوصول إليه عبر الشبكة العامة. وهو مناسب للسيناريوهات التي تحتاج فيها إلى رفع صورة أولا ثم استخدام رابط URL لاستدعاء واجهة التعرف.

مثال قديم

✅ استجابة ناجحة:

https://cdn.example.com/uploads/abc123.jpg

❌ رد فاشل (لم يتم رفع الملف أو استثناء الرفع):

no

يعيد نصا عاديا no يشير إلى أن الملف لم يتم استلامه أو حدوث استثناء أثناء عملية الرفع.

رابط الطلب: /Code.aspx?op=count&app=api&token=YOUR_TOKEN

طريقة الاستدعاء: GET

من خلال هذه الواجهة، يمكنك عرض عدد مرات استخدام الرمز اليوم والحصة المتبقية.

مثال قديم

✅ استجابة ناجحة:

{
  "Account": "api",
  "TodayCount": 52, // مستخدم اليوم"LimitCount": 9948       // إجمالي عدد البقايا الحالية
}

❌ استجابة الفشل (رمز غير صالح أو غير مرسل):

{
  "Account": "api",
  "TodayCount": 0,
  "LimitCount": 0
}

ملاحظة: إذا كان الرمز غير صالح، فلن يتم الإبلاغ عن أي خطأ، لكنه سيعود ب JSON بقيم 0، حسب ما إذا كان عدد الحدود نعم أم لا 0 لتقييم صحة الرمز.