Guide de développement de l’interface API ouverte

Toutes les requêtes d’interface doivent inclure les paramètres d’authentification suivants dans l’URL :

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

Méthode d’appel: POST

Les paramètres sont orthographiés uniformément dans l’URL, et les données de l’image sont transmises via le corps POST (multipart est pris en charge) flux de fichiers, champ de formulaire ou texte brut).

2.1 Entrez l’image pour être reconnu (choisissez l’une des trois)

2.2 Mode de base et contrôle moteur

2.3 Règles de mise en page et de mise en page (optionnelle)

Les paramètres suivants passent les valeurs 1 Active le traitement correspondant, valeur 0 Pas allumé.
S’il n’y a pas de besoin spécifique, il est recommandé de ne pas le transmettre, et de laisser le contrôle au système :

2.4 Description de la valeur de retour (JSON)

L’interface de reconnaissance restitue un format JSON standard. La valeur est null le champ est automatiquement omis.

Domaines de haut niveau

result Sous-objet – Résultat textuel

result Sous-objet - données 🗺️ de positionnement des coordonnées

Les champs suivants contiennent la position précise de chaque bloc de texte sur l’image originale, adaptée à des scénarios tels que les surlignages, l’extraction de zone, etc.

verticalText Structure d’objets TextCellInfo

[
  {
    "words": "Le contenu textuel reconnu",
    "trans": "Résultats de traduction (s’il y en a)",
    "pageIndex": 0,
    "location": {
      "left": 120.0,
      "top": 45.0,
      "width": 230.0,
      "height": 28.0
    }
  },
  ...
]

result Sous-objet - Téléchargement de fichier

files La structure d’objet DownLoadInfo dans la structure d’objets DownLoadInfo

state Énumération par État

Exemple arrière

✅ Réponse réussie (avec données de coordonnées) :

{
  "ocrType": 0,
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "processId": 3,
  "processName": "OCR-Node-01",
  "state": 2,
  "result": {
    "autoText": "Texte complet après la fusion intelligente",
    "spiltText": "Texte original divisé par paragraphes",
    "verticalText": "[{\"words\":\"Bonjour\",\"location\":{\"left\":10,\"top\":20,\"width\":80,\"height\":22}}]",
    "resultType": 0,
    "lang": "chi_sim"
  }
}

❌ Réponse à l’erreur/limite :

{
  "ocrType": 0,
  "processName": "Conseils",
  "result": {
    "spiltText": "Le quota d’API d’aujourd’hui a été épuisé, merci de recharger et de continuer à l’utiliser！",
    "autoText": "Le quota d’API d’aujourd’hui a été épuisé, merci de recharger et de continuer à l’utiliser！"
  },
  "id": 1
}

URL de demande: /Code.ashx?op=idcode&app=api&token=YOUR_TOKEN

Méthode d’appel: POST

Fonction: Retourné selon l’interface de reconnaissance id Interrogez les résultats du traitement asynchrone. Quand l’interface de reconnaissance revient state=0(en attente), vous pouvez utiliser cette interface pour interroger afin d’obtenir le résultat final.

Exemple arrière

✅ Réponse réussie :

[
  {
    "ocrType": 0,
    "id": "a1b2c3d4-...",
    "processName": "OCR-Node-01",
    "state": 2,
    "result": {
      "autoText": "Identifier le texte résultant",
      "spiltText": "Texte segmenté",
      "resultType": 0
    }
  }
]

❌ Réponse échouée (ID n’existe pas ou résultat expiré) :

no

Retourne le texte clair no Indique qu’aucun résultat n’a été trouvé pour cet ID, qui pourrait être un ID L’erreur ou le résultat est expiré et est effacé.

URL de demande: /Code.ashx?op=imgUpload&app=api&token=YOUR_TOKEN

Méthode d’appel: POST (multipart/form-data)

Fonction: Téléchargez une image sur le lit d’images gratuit et retournez une URL de lien direct accessible sur le réseau public. Il convient aux situations où il faut d’abord télécharger une image puis utiliser l’URL pour appeler l’interface de reconnaissance.

Exemple arrière

✅ Réponse réussie :

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

❌ Réponse échouée (fichier non téléchargé ou exception de téléchargement) :

no

Retourne le texte clair no Indique que le fichier n’a pas été reçu ou qu’une exception a eu lieu pendant le processus de téléversement.

URL de demande: /Code.aspx?op=count&app=api&token=YOUR_TOKEN

Méthode d’appel: GET

Grâce à cette interface, vous pouvez voir le nombre de fois où le jeton a été utilisé aujourd’hui et le quota restant.

Exemple arrière

✅ Réponse réussie :

{
  "Account": "api",
  "TodayCount": 52, // Utilisé aujourd’hui"LimitCount": 9948       // Le nombre total de restes actuels
}

❌ Réponse à l’échec (jeton invalide ou non transmis) :

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

Note : Si le jeton est invalide, aucune erreur ne sera signalée, mais le JSON sera retourné avec toutes les valeurs de 0, selon que le LimitCount est oui ou non 0 pour juger de la validité du jeton.