API ReferenceDocumentation APIImages 2D-Doc

Créer une image 2D-Doc

Afficher en Markdown

Génère l’image Datamatrix portant le 2D-Doc à partir d’un code signé, ou signe d’abord la zone de données quand une zone de données ou une source est fournie. L’image est renvoyée encodée en Base64 avec ses dimensions en pixels.

Authentification : certificat client (mutual TLS).

Requête

This endpoint expects an object.
image2DDocSourceobjectRequis

Le code signé, la zone de données ou la source à rendre.

textOptionsobjectOptionnel

Texte imprimé à côté du code-barres. S’il est omis, le texte 2D-DOC est imprimé sous le code-barres.

imageFormatenumOptionnel

Format de sortie de l’image. Le PNG est généré sans transparence.

Valeurs autorisées:
requestIDstringOptionnel

Identifiant de la requête défini par l’appelant, renvoyé tel quel dans la réponse. Facultatif dans les appels REST ; requis par le schéma XML du contrat SOAP.

Réponse

L’image 2D-Doc générée. Les erreurs métier sont renvoyées en HTTP 200 : result porte un majorCode non nul.

resultobject

Résultat de l’opération.

widthinteger

Largeur de l’image en pixels. Dépend des données encodées ; 0 quand aucune image n’est générée.

heightinteger

Hauteur de l’image en pixels. Dépend des données encodées ; 0 quand aucune image n’est générée.

imagestringOptionnelformat: "byte"

L’image Datamatrix portant le 2D-Doc, encodée en Base64, dans le format demandé. Absente quand l’image n’a pu être générée.

requestIDstringOptionnel

L’identifiant donné dans la requête.

Erreurs

400
Create Image2d Doc Request Bad Request Error