This add-on is operated by Expedited Security

Identify and protect images by adding a watermark to them.

Last updated July 28, 2023

Watermarker is an add-on to identify and protect images by adding a watermark to them.

Protect your images by adding your logo to them on the fly. Watermarking helps extend your brand and encourage attribution as images are used across social media and embedded in websites.

Watermarker exposes an API and has supported examples for Ruby, PHP, Python, Node and Java.

Provisioning the add-on

Watermarker can be attached to a Heroku application via the CLI:

$ heroku addons:create watermarker
-----> Adding watermarker to sharp-mountain-4005... done, v18 (free)

Once Watermarker has been added a WATERMARKER_API_KEY config variable will contain your specific API key granting access to the newly provisioned Watermarker instance. This can be confirmed using the heroku config:get command.

$ heroku config:get WATERMARKER_API_KEY
Bl4XHVbdsf5GIXQbqTfXR5IrpuuXER2kaVc2zNnA

After installing Watermarker your application should be modified to fully integrate with the add-on.

Local setup

Environment setup

After provisioning the add-on it’s necessary to locally replicate the config vars so your development environment can operate against the service.

Use the Heroku Local command-line tool to configure, run and manage process types specified in your app’s Procfile. Heroku Local reads configuration variables from a .env file. To view all of your app’s config vars, type heroku config. Use the following command for each value that you want to add to your .env file.

$ heroku config:get WATERMARKER_API_KEY -s  >> .env

For more information, see the Heroku Local article.

Input Parameter Descriptions

All languages will follow this call structure for inputs.

Using with Ruby

Install the Watermarker gem.

# In your Gemfile
gem 'watermarker', git: 'https://github.com/mbuckbee/Watermarker-Gem.git'

Making a Request

> require 'watermarker'
=> true

# Note: the 'Controller' here is not a reference to Rails controllers
# but an internal structure, won't interfere with your Rails app and will
# work fine in a standalone ruby app or another framework

> wm = Watermarker::APIController.new
> data = wm.lookup("https://www.expeditedaddons.com/base.png","https://www.expeditedaddons.com/watermark.png","100","center","","")

# Writes the resized file data to the local directory
> File.open("base-with-watermark.png","w"){|f| f.write(data)}

Watermarked File

Base File

Using with PHP

<?php

$ch = curl_init('https://watermarker.expeditedaddons.com/?api_key=' . getenv('WATERMARKER_API_KEY') . '&height=100&image_url=https%3A%2F%2Fwww.expeditedaddons.com%2Fbase.png&opacity=50&position=center&watermark_url=https%3A%2F%2Fwww.expeditedaddons.com%2Fwatermark.png&width=100');

$response = curl_exec($ch);
curl_close($ch);

var_dump($response);

Using with Python

import os
from urllib2 import Request, urlopen

request = Request('https://watermarker.expeditedaddons.com/?api_key=' + os.environ['WATERMARKER_API_KEY'] + '&height=100&image_url=https%3A%2F%2Fwww.expeditedaddons.com%2Fbase.png&opacity=50&position=center&watermark_url=https%3A%2F%2Fwww.expeditedaddons.com%2Fwatermark.png&width=100')

response_body = urlopen(request).read()
print response_body

Using with Node

var request = require('request');

request('https://watermarker.expeditedaddons.com/?api_key=' + process.env.WATERMARKER_API_KEY + '&height=100&image_url=https%3A%2F%2Fwww.expeditedaddons.com%2Fbase.png&opacity=50&position=center&watermark_url=https%3A%2F%2Fwww.expeditedaddons.com%2Fwatermark.png&width=100', function (error, response, body) {
  console.log('Status:', response.statusCode);
  console.log('Headers:', JSON.stringify(response.headers));
  console.log('Response:', body);
});

Using with Java

// Maven : Add these dependencies to your pom.xml (java6+)
// <dependency>
//     <groupId>org.glassfish.jersey.core</groupId>
//     <artifactId>jersey-client</artifactId>
//     <version>2.8</version>
// </dependency>
// <dependency>
//     <groupId>org.glassfish.jersey.media</groupId>
//     <artifactId>jersey-media-json-jackson</artifactId>
//     <version>2.8</version>
// </dependency>

import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Entity;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.MediaType;

Client client = ClientBuilder.newClient();
Response response = client.target('https://watermarker.expeditedaddons.com/?api_key=' + System.getenv('WATERMARKER_API_KEY') + '&height=100&image_url=https%3A%2F%2Fwww.expeditedaddons.com%2Fbase.png&opacity=50&position=center&watermark_url=https%3A%2F%2Fwww.expeditedaddons.com%2Fwatermark.png&width=100}')
  .request(MediaType.TEXT_PLAIN_TYPE)
  .get();

System.out.println("status: " + response.getStatus());
System.out.println("headers: " + response.getHeaders());
System.out.println("body:" + response.readEntity(String.class));

Dashboard

The Watermarker dashboard allows you to monitor your API usage limits.

The dashboard can be accessed via the CLI:

$ heroku addons:open watermarker
Opening watermarker for sharp-mountain-4005

or by visiting the Heroku Dashboard and selecting the application in question. Select Watermarker from the Add-ons menu.

Troubleshooting

As a sanity check it is sometimes useful to bypass your app stack and check the endpoint, your API Key and parameters directly.

Test with your browser

# Modify the following to use your actual API Key
https://watermarker.expeditedaddons.com/?api_key=REPLACE_WITH_YOUR_WATERMARKER_API_KEY&height=100&image_url=https%3A%2F%2Fwww.expeditedaddons.com%2Fbase.png&opacity=50&position=center&watermark_url=https%3A%2F%2Fwww.expeditedaddons.com%2Fwatermark.png&width=100

A successful call will return your requested data with a HTTP result code of 200 along with your data. We recommend the JSON Formatter extension as a useful tool.

Your API key can be found on your Watermarker dashboard.

Migrating between plans

Use the heroku addons:upgrade command to migrate to a new plan.

$ heroku addons:upgrade watermarker:newplan
-----> Upgrading watermarker:newplan to sharp-mountain-4005... done, v18 ($49/mo)
       Your plan has been updated to: watermarker:newplan

Removing the add-on

Watermarker can be removed via the CLI.

$ heroku addons:destroy watermarker
-----> Removing watermarker from sharp-mountain-4005... done, v20 (free)

Support

All Watermarker support and runtime issues should be submitted via one of the Heroku Support channels. Any non-support related issues or product feedback is welcome at support@expeditedaddons.com