Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The imageprocessing action of the RESTAPI domain allows the management of endpoint call authorisation. Its unique parameter is actionName, the action identifier.

Error codes

HTTP Code

API Code

Definition

404

404/1100

Unknown action

403

403/1100

Unreachable action (or forbidden)

422

422/1100

Unreachable action (configuration problem)

422

422/1101

Resource not found

403

403/1102

Forbidden action

500

500/1100

Internal server error (error with command, preset or image file…​)

EndPoint: available action list

...

The catalog action of RESTAPI domain allows the management of the endpoint call authorisation. Its unique parameter is endPoint, with a imageprocessing value.

Error codes

HTTP Code

API Code

Definition

403

403/601

Unreachable catalog (or forbidden)

Command set

Introduction

A command set is a list of commands that will be executed one after the other on the image. There are three different forms of syntaxes:

...

Code Block
first line
second line with: \n

)

You can use \u followed by unicode codepoint (four hexadecimal digits mandatory) to specify special characters:

...

Specifies a location in the image, like in this grid:

northwest

north

northeast

west

center

east

southwest

south

southeast

  • north means at the center top

    Code Block
    "gravity": "north"
  • northeast means at the top right

    Code Block
    "gravity": "northeast"
  • east means at the center right

    Code Block
    "gravity": "east"
  • southeast means at the bottom right

    Code Block
    "gravity": "southeast"
  • south means at the center bottom

    Code Block
    "gravity": "south"
  • southwest means at the bottom left

    Code Block
    "gravity": "southwest"
  • west means at the center left

    Code Block
    "gravity": "west"
  • northwest means at the top left

    Code Block
    "gravity": "northwest"
  • center means at the center

    Code Block
    "gravity": "center"

...

  • Provide text, font, background and foreground to draw centered text on image

    Example: f_Candice|24|bold,tx_"\u00a9Wedia",bg_black,fg_#00A5C8

  • Provide font, text and foreground to draw centered text on image

    Example: f_Candice|24|bold,tx_"\u00a9Wedia",fg_#00A5C8

  • Provide font, text and background to draw white centered text width background on image

    Example: f_Candice|24|bold,tx_"\u00a9Wedia",bg_black

  • Provide font and text to draw white centered text on image

    Example: f_Candice|24|bold,tx_"\u00a9Wedia"

Available fill patterns

Value

Description

Notes

BRICKS

brick pattern, 16×16

bricksImage Modified

CHECKERBOARD

checkerboard, 30×30

checkerboardImage Modified

CIRCLES

circles pattern, 16×16

circlesImage Modified

CROSSHATCH

crosshatch pattern, 8×4

crosshatchImage Modified

CROSSHATCH30

crosshatch pattern with lines at 30 degrees, 8×4

crosshatch30Image Modified

CROSSHATCH45

crosshatch pattern with lines at 45 degrees, 8×4

crosshatch45Image Modified

FISHSCALES

fish scales pattern, 16×8

fishscalesImage Modified

GRAY0

0% intensity gray, 32×32

gray0Image Modified

GRAY5

5% intensity gray, 32×32

gray5Image Modified

GRAY10

10% intensity gray, 32×32

gray10Image Modified

GRAY15

15% intensity gray, 32×32

gray15Image Modified

GRAY20

20% intensity gray, 32×32

gray20Image Modified

GRAY25

25% intensity gray, 32×32

gray25Image Modified

GRAY30

30% intensity gray, 32×32

gray30Image Modified

GRAY35

35% intensity gray, 32×32

gray35Image Modified

GRAY40

40% intensity gray, 32×32

gray40Image Modified

GRAY45

45% intensity gray, 32×32

gray45Image Modified

GRAY50

50% intensity gray, 32×32

gray50Image Modified

GRAY55

55% intensity gray, 32×32

gray55Image Modified

GRAY60

60% intensity gray, 32×32

gray60Image Modified

GRAY65

65% intensity gray, 32×32

gray65Image Modified

GRAY70

70% intensity gray, 32×32

gray70Image Modified

GRAY75

75% intensity gray, 32×32

gray75Image Modified

GRAY80

80% intensity gray, 32×32

gray80Image Modified

GRAY85

85% intensity gray, 32×32

gray85Image Modified

GRAY90

90% intensity gray, 32×32

gray90Image Modified

GRAY95

95% intensity gray, 32×32

gray95Image Modified

GRAY100

100% intensity gray, 32×32

gray100Image Modified

HEXAGONS

hexagon pattern, 30×18

hexagonsImage Modified

HORIZONTAL

horizontal line pattern, 8×4

horizontalImage Modified

HORIZONTAL2

horizontal line pattern, 8×8

horizontal2Image Modified

HORIZONTAL3

horizontal line pattern, 9×9

horizontal3Image Modified

HORIZONTALSAW

horizontal saw-tooth pattern, 16×8

horizontalsawImage Modified

HS_BDIAGONAL

backward diagonal line pattern (45 degrees slope), 8×8

hs bdiagonalImage Modified

HS_CROSS

cross line pattern, 8×8

hs crossImage Modified

HS_DIAGCROSS

diagonal line cross pattern (45 degrees slope), 8×8

hs diagcrossImage Modified

HS_FDIAGONAL

forward diagonal line pattern (45 degrees slope), 8×8

hs fdiagonalImage Modified

HS_HORIZONTAL

horizontal line pattern, 8×8

hs horizontalImage Modified

HS_VERTICAL

vertical line pattern, 8×8

hs verticalImage Modified

LEFT30

forward diagonal pattern (30 degrees slope), 8×4

left30Image Modified

LEFT45

forward diagonal pattern (45 degrees slope), 8×8

left45Image Modified

LEFTSHINGLE

left shingle pattern, 24×24

leftshingleImage Modified

OCTAGONS

octagons pattern, 16×16

octagonsImage Modified

RIGHT30

backward diagonal line pattern (30 degrees), 8×4

right30Image Modified

RIGHT45

backward diagonal line pattern (30 degrees), 8×8

right45Image Modified

RIGHTSHINGLE

right shingle pattern, 24×24

rightshingleImage Modified

SMALLFISHSCALES

small fish scales pattern, 8×8

smallfishscalesImage Modified

VERTICAL

vertical line pattern, 8×8

verticalImage Modified

VERTICAL2

vertical line pattern, 8×8

vertical2Image Modified

VERTICAL3

vertical line pattern, 9×9

vertical3Image Modified

VERTICALBRICKS

vertical brick pattern, 16×16

verticalbricksImage Modified

VERTICALLEFTSHINGLE

vertical left shingle pattern, 24×24

verticalleftshingleImage Modified

VERTICALRIGHTSHINGLE

vertical right shingle pattern, 24×24

verticalrightshingleImage Modified

VERTICALSAW

vertical saw-tooth pattern, 8×16

verticalsawImage Modified