Leitfaden zur Entwicklung von Open-API-Schnittstellen

Alle Schnittstellenanfragen müssen die folgenden Authentifizierungsparameter in der URL enthalten:

Anfrage-URL: /Code.ashx?op=code&app=api&token=YOUR_TOKEN&type=0

Aufrufmethode: POST

Die Parameter werden einheitlich in der URL geschrieben, und die Bilddaten werden durch den POST-Körper geleitet (Multipart wird unterstützt) Dateifluss, Formularfeld oder Klartext).

2.1 Geben Sie das zu erkennende Bild ein (wählen Sie eines von drei)

2.2 Kernmodus und Motorsteuerung

2.3 Formatierungs- und Layoutregeln (optional)

Die folgenden Parameter passieren Werte 1 Schalte die entsprechende Verarbeitung ein, Wert 0 Nicht an.
Wenn kein spezieller Bedarf besteht, wird empfohlen, ihn nicht weiterzugeben und es dem System zu überlassen, die Entscheidung zu übernehmen:

2.4 Rückgabe-Wertbeschreibung (JSON)

Die Erkennungsschnittstelle liefert ein Standard-JSON-Format. Der Wert ist null Feld wird automatisch weggelassen.

Top-Level-Felder

result Sub-Objekt – Textergebnis

result Teilobjekt – Koordinatenpositionsdaten 🗺️

Die folgenden Felder enthalten die genaue Position jedes Textblocks im Originalbild, geeignet für Szenarien wie das Markieren von Überlagerungen, Flächenextraktion usw.

verticalText TextCellInfo-Objektstruktur

[
  {
    "words": "Der erkannte Textinhalt",
    "trans": "Übersetzungsergebnisse (falls vorhanden)",
    "pageIndex": 0,
    "location": {
      "left": 120.0,
      "top": 45.0,
      "width": 230.0,
      "height": 28.0
    }
  },
  ...
]

result Sub-Objekt – Dateidownload

files Die DownLoadInfo-Objektstruktur in der DownLoadInfo-Objektstruktur

state Staatsaufzählung

Rückenbeispiel

✅ Erfolgreiche Antwort (mit Koordinatendaten):

{
  "ocrType": 0,
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "processId": 3,
  "processName": "OCR-Node-01",
  "state": 2,
  "result": {
    "autoText": "Vollständiger Text nach Smart Merge",
    "spiltText": "Originaltext nach Absätzen unterteilt",
    "verticalText": "[{\"words\":\"Hallo\",\"location\":{\"left\":10,\"top\":20,\"width\":80,\"height\":22}}]",
    "resultType": 0,
    "lang": "chi_sim"
  }
}

❌ Fehler-/Limitantantwort:

{
  "ocrType": 0,
  "processName": "Tipps",
  "result": {
    "spiltText": "Die heutige API-Quote ist erschöpft, bitte laden Sie auf und nutzen Sie sie weiter.！",
    "autoText": "Die heutige API-Quote ist erschöpft, bitte laden Sie auf und nutzen Sie sie weiter.！"
  },
  "id": 1
}

Anfrage-URL: /Code.ashx?op=idcode&app=api&token=YOUR_TOKEN

Aufrufmethode: POST

Funktion: Zurückgegeben gemäß der Erkennungsschnittstelle id Abfrage der Ergebnisse der asynchronen Verarbeitung. Wenn die Erkennungsschnittstelle zurückkehrt state=0(ausstehend), können Sie diese Oberfläche nutzen, um das Endergebnis zu erhalten.

Rückenbeispiel

✅ Erfolgreiche Antwort:

[
  {
    "ocrType": 0,
    "id": "a1b2c3d4-...",
    "processName": "OCR-Node-01",
    "state": 2,
    "result": {
      "autoText": "Identifizieren Sie den resultierenden Text",
      "spiltText": "Segmentierter Text",
      "resultType": 0
    }
  }
]

❌ Fehlgeschlagene Antwort (ID existiert nicht oder Ergebnis ist abgelaufen):

no

Gibt Klartext zurück no Zeigt an, dass für diese ID kein Ergebnis gefunden wurde, die möglicherweise eine ID ist Der Fehler oder das Ergebnis ist abgelaufen und beseitigt.

Anfrage-URL: /Code.ashx?op=imgUpload&app=api&token=YOUR_TOKEN

Aufrufmethode: POST (multipart/form-data)

Funktion: Laden Sie ein Bild auf das kostenlose Bildbett hoch und geben Sie eine direkte Link-URL zurück, die im öffentlichen Netzwerk zugänglich ist. Sie eignet sich für Situationen, in denen Sie zuerst ein Bild hochladen und dann die URL verwenden, um die Erkennungsoberfläche aufzurufen.

Rückenbeispiel

✅ Erfolgreiche Antwort:

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

❌ Fehlgeschlagene Antwort (Datei nicht hochgeladen oder Upload-Ausnahme):

no

Gibt Klartext zurück no Zeigt an, dass die Datei nicht empfangen wurde oder während des Hochladens eine Ausnahme eingetreten ist.

Anfrage-URL: /Code.aspx?op=count&app=api&token=YOUR_TOKEN

Aufrufmethode: GET

Über diese Benutzeroberfläche können Sie sehen, wie oft der Token heute verwendet wurde und wie oft die verbleibende Quote vorhanden ist.

Rückenbeispiel

✅ Erfolgreiche Antwort:

{
  "Account": "api",
  "TodayCount": 52, // Heute gebraucht"LimitCount": 9948       // Die Gesamtzahl der aktuellen Ströme bleibt übrig
}

❌ Fehlerantwort (ungültiges oder nicht übertragenes Token):

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

Hinweis: Wenn das Token ungültig ist, wird kein Fehler gemeldet, aber es wird JSON mit allen Werten von 0 zurückgegeben, abhängig davon, ob der LimitCount ja ist oder nicht. 0, um die Gültigkeit des Tokens zu beurteilen.