Ръководство за разработка на Open API интерфейс

Всички заявки за интерфейс трябва да включват следните параметри за удостоверяване в URL адреса:

Заявка 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
}

Заявка URL: /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
    }
  }
]

❌ Неуспешен отговор (ID не съществува или резултатът е изтекъл):

no

Връща обикновен текст no Показва, че не е намерен резултат за този ID, който може да е ID Грешката или резултатът са изтекли и се изчистват.

Заявка URL: /Code.ashx?op=imgUpload&app=api&token=YOUR_TOKEN

Метод на извикване: POST (multipart/form-data)

Функция: Качете изображение в безплатното легло с изображения и върнете директен URL на връзка, достъпен в публичната мрежа. Подходящо е за ситуации, в които първо трябва да качите изображение и след това да използвате URL адреса, за да извикате интерфейса за разпознаване.

Пример от задната страна

✅ Успешен отговор:

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

❌ Неуспешен отговор (файлът не е качен или изключение за качване):

no

Връща обикновен текст no Показва, че файлът не е получен или е настъпило изключение по време на процеса на качване.

Заявка URL: /Code.aspx?op=count&app=api&token=YOUR_TOKEN

Метод на извикване: GET

Чрез този интерфейс можете да видите броя пъти, в които токен е бил използван днес, както и оставащата квота.

Пример от задната страна

✅ Успешен отговор:

{
  "Account": "api",
  "TodayCount": 52, // Използвано днес"LimitCount": 9948       // Общият брой на текущите локомотиви остава
}

❌ Отговор при неуспех (невалиден или непредаден токен):

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

Забележка: Ако токенът е невалиден, няма да се отчете грешка, но ще върне JSON с всички стойности 0, в зависимост от това дали LimitCount е да или не 0 за оценка на валидността на жетона.