...
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 | |
CHECKERBOARD | checkerboard, 30×30 | |
CIRCLES | circles pattern, 16×16 | |
CROSSHATCH | crosshatch pattern, 8×4 | |
CROSSHATCH30 | crosshatch pattern with lines at 30 degrees, 8×4 | |
CROSSHATCH45 | crosshatch pattern with lines at 45 degrees, 8×4 | |
FISHSCALES | fish scales pattern, 16×8 | |
GRAY0 | 0% intensity gray, 32×32 | |
GRAY5 | 5% intensity gray, 32×32 | |
GRAY10 | 10% intensity gray, 32×32 | |
GRAY15 | 15% intensity gray, 32×32 | |
GRAY20 | 20% intensity gray, 32×32 | |
GRAY25 | 25% intensity gray, 32×32 | |
GRAY30 | 30% intensity gray, 32×32 | |
GRAY35 | 35% intensity gray, 32×32 | |
GRAY40 | 40% intensity gray, 32×32 | |
GRAY45 | 45% intensity gray, 32×32 | |
GRAY50 | 50% intensity gray, 32×32 | |
GRAY55 | 55% intensity gray, 32×32 | |
GRAY60 | 60% intensity gray, 32×32 | |
GRAY65 | 65% intensity gray, 32×32 | |
GRAY70 | 70% intensity gray, 32×32 | |
GRAY75 | 75% intensity gray, 32×32 | |
GRAY80 | 80% intensity gray, 32×32 | |
GRAY85 | 85% intensity gray, 32×32 | |
GRAY90 | 90% intensity gray, 32×32 | |
GRAY95 | 95% intensity gray, 32×32 | |
GRAY100 | 100% intensity gray, 32×32 | |
HEXAGONS | hexagon pattern, 30×18 | |
HORIZONTAL | horizontal line pattern, 8×4 | |
HORIZONTAL2 | horizontal line pattern, 8×8 | |
HORIZONTAL3 | horizontal line pattern, 9×9 | |
HORIZONTALSAW | horizontal saw-tooth pattern, 16×8 | |
HS_BDIAGONAL | backward diagonal line pattern (45 degrees slope), 8×8 | |
HS_CROSS | cross line pattern, 8×8 | |
HS_DIAGCROSS | diagonal line cross pattern (45 degrees slope), 8×8 | |
HS_FDIAGONAL | forward diagonal line pattern (45 degrees slope), 8×8 | |
HS_HORIZONTAL | horizontal line pattern, 8×8 | |
HS_VERTICAL | vertical line pattern, 8×8 | |
LEFT30 | forward diagonal pattern (30 degrees slope), 8×4 | |
LEFT45 | forward diagonal pattern (45 degrees slope), 8×8 | |
LEFTSHINGLE | left shingle pattern, 24×24 | |
OCTAGONS | octagons pattern, 16×16 | |
RIGHT30 | backward diagonal line pattern (30 degrees), 8×4 | |
RIGHT45 | backward diagonal line pattern (30 degrees), 8×8 | |
RIGHTSHINGLE | right shingle pattern, 24×24 | |
SMALLFISHSCALES | small fish scales pattern, 8×8 | |
VERTICAL | vertical line pattern, 8×8 | |
VERTICAL2 | vertical line pattern, 8×8 | |
VERTICAL3 | vertical line pattern, 9×9 | |
VERTICALBRICKS | vertical brick pattern, 16×16 | |
VERTICALLEFTSHINGLE | vertical left shingle pattern, 24×24 | |
VERTICALRIGHTSHINGLE | vertical right shingle pattern, 24×24 | |
VERTICALSAW | vertical saw-tooth pattern, 8×16 |