POST /documentprocessing/barcodes/create

POST https://example.com/documentprocessing/barcodes/create

Description

Creates a barcode image.

Examples

The following example creates a Code128 barcode.

# Request:
curl --location --request POST 'https://trial.dsserver.io/documentprocessing/barcodes/create?barcodeType=code128' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer fePFHv8OtIyRSCAdOnn7USc9kKdYB2rg' \
    --data-raw '{
        "additionalText": "Sets an additional text that is displayed below or above the barcode image",
        "alignment": "BottomCenter",
        "backColor": "#ffffff",
        "foreColor": "#000000",
        "showText": true,
        "text": "Sets the text the barcode should encode.",
        "textAlignment": "Bottom",
        "upperTextLength": 23
    }'

# Result:
"iVBORw0KGgoAAAANSUhEUgAA[..]"

Authorization

This endpoint supports the OAuth authorization method. DS Server checks the access token only when OAuth is enabled in the admin portal (see Enable OAuth). With OAuth disabled, the default of a new installation, the endpoint accepts requests without a token.

DS Server implements OAuth as the authorization method. Two flows are supported:

• Authorization Code
• Client Credentials

To use the Client Credentials flow, switch on Allow “Client Credentials” grant type in the security profile (see OAuth Grant Types).

In both cases, a valid access token returned from the OAuth endpoints must be passed in a Bearer Authorization Header, as a Query Parameter or in a Cookie.

Authorization Header

Query Parameter

Cookie

Request Parameters

Request Payload

Barcode

Success Response

Error Response