Marketron Image Engine is a service, used in Marketron application. It's main purpose is to generate screenshot of the given URL, transform it to fit into template, and paste it into given template.
This service is built with the intention to be as basic as possible. This means that this service provides an HTTP endpoint, which other services can call.
The best way to set up the project is by using Docker. Run the following command to start up the service:
docker run -it --rm \
-e AWS_ACCESS_KEY_ID=<INSERT_YOUR_AWS_ACCESS_KEY> \
-e AWS_SECRET_ACCESS_KEY=<INSERT_YOUR_AWS_SECRET_KEY> \
-e AWS_REGION=<INSERT_AWS_REGION> \
-e AWS_S3_BUCKET=<INSERT_BUCKET_NAME> \
-p "3000:3000" \
tavsec/marketron-image-engine:v1.0.0| Variable | Required | Description |
|---|---|---|
| AWS_ACCESS_KEY_ID | yes | AWS access key |
| AWS_SECRET_ACCESS_KEY | yes | AWS secret key |
| AWS_REGION | yes | AWS region |
| AWS_S3_BUCKET | yes | AWS S3 Bucket, on which the generated images will be uploaded |
| AWS_ENDPOINT | no | Can be set to use other S3-compatible storages. |
| METRIC_HEADERS_ENABLED | no | Setting this variable to "true" will enable metric headers. Default is disabled. |
| CRAWLER_TIMEOUT | no | How long (in seconds) the crawler will wait for the website. Default is 10 seconds |
Application consists of one main endpoint, and one healthcheck endpoint.
To generate new image, use GET /image request, like so:
curl --location -g --request GET \
'http://localhost:3000/image? \
url=https://www.marketron.app& \
templateImage=https://marketron-exports-images.s3.eu-central-1.amazonaws.com/a6f937aa-b53d-4a8f-9c0d-b70e8413fc7e.png& \
coordinates[0][x]=88& \
coordinates[0][y]=126& \
coordinates[1][x]=125& \
coordinates[1][y]=466& \
coordinates[2][x]=650& \
coordinates[2][y]=448& \
coordinates[3][x]=597& \
coordinates[3][y]=138& \
viewportWidth=1920& \
viewportHeight=1080' \
--header 'Content-Type: multipart/form-data'url: URL of the website, for which you want to generate the mockup.
templateImage: Cutout image, on which the screenshot of the website will be pasted on. Must have transparent cutout, in PNG format.
coordinates: Array of coordinates (in pixels), where the cutout is on the templateImage. Must be in the following order: top-left, bottom-left, bottom-right, top-right.
viewportWidth: Width of the screenshot.
viewportHeight: Height of the screenshot.
Endpoint will return filename of the generated image, which is uploaded to the S3 bucket.
You can use GET / or GET /health to use as a healthcheck.
If you set the METRIC_HEADERS_ENABLED to true, the /image endpoint will pass the following response headers:
| Header | Description |
|---|---|
| X-Marketron-Metric-Crawler | How long (in ms) crawler needed to get the website screenshot. |
| X-Marketron-Metric-Transformer | How long (in ms) application needed to warp screenshot to template |
| X-Marketron-Metric-Uploader | How long (in ms) application needed to upload image |