API Reference

Name

Type

Description

client_id (required)

string

The client_id parameter is required for authentication. We associate the user with the client ID provided. Find out how can you obtain your client ID.

signature (required)

string

The signature must be calculated by you and added to the request. See How to sign a request for more information.

action (required)

string

The API method that should be called. In this case the value should be create-banner.

t (required)

timestamp

Specifies the current timestamp in seconds.

identifier (required)

string

A unique identifier for every user.
Examples: [email protected], 2AF832 etc.

name

string

User's name.

multiple_slides

integer

Possible values:

This value can be set in the admin panel, but if you specify it in the request, the setting from admin panel will be overwritten.

animations

integer

Possible values:

This value can be set in the admin panel, but if you specify it in the request, the setting from the admin panel will be overwritten.

cancel_url

string

If specified, there will be a "Close banner maker" link in the editor which, if clicked, will redirect the user to the specified link.
​
This value can be set in the admin panel, but if you specify it in the request, the setting from the admin panel will be overwritten.

use_banner_url

string

If specified, it will redirect the user to the specified link upon banner Save.
​
This value can be set in the admin panel, but if you specify it in the request, the setting from the admin panel will be overwritten.

mode

string

Possible values:

from

string

Requires a banner hash.
If specified, the returned URL will open the Bannersnack editor with that banner loaded, like a template.
​
​Note: The banner with the given hash will not be modified, but a new banner will be generated instead.

width, height

integer

If provided, the editor will load a blank banner with the specified width and height. Maximum value is 3000 and minimum value is 10.

Name

Type

Description

code

integer

The code will indicate the status of your request.
​code 200 represents a successful response.

url

string

The URL to the Bannersnack editor.

Name

Type

Description

client_id (required)

string

The client_id parameter is required for authentification. We associate the user to the client ID provided. Find out how can you obtain your client ID.

signature (required)

string

The signature must be calculated by you and added to the request. See How to sign a request for more information.

action (required)

string

The API method that should be called. In this case the value should be create-bannerset.

t (required)

timestamp

Specifies the current timestamp in seconds.

identifier (required)

string

A unique identifier for every user.
Examples: [email protected], 2AF832 etc.

name

string

User's name.

animations

integer

Posible values:

This value can be set in admin panel, but if you specify it in the request, the setting from admin panel will be overwritten.

cancel_url

string

If specified, there will be a "Close banner maker" link in generator which, if clicked, will redirect the user to the specified link.
​
This value can be set in admin panel, but if you specify it in the request, the setting from admin panel will be overwritten.

use_banner_url

string

If specified, there will be a "Use this banner" button for each banner in the banners list which, if clicked, will redirect the user to the specified link along with the banner hash.
​
This value can be set in admin panel, but if you specify it in the request, the setting from admin panel will be overwritten.

mode

string

Posible values:

from_bannerset

string

Requires a bannerset hash.
If specified, the returned URL will open the Bannesnack generator with that bannerset loaded, like a template.
​
​Note: The bannerset with the given hash will not be modified, a new bannerset will be generated instead.

Name

Type

Description

code

integer

The code will indicate the status of your request.
​code 200 represents an successful response.

url

string

The URL to the Bannersnack generator.

Name

Type

Description

client_id (required)

string

The client_id parameter is required for authentification. We associate the user to the client ID provided. Find out how can you obtain your client ID.

signature (required)

string

The signature must be calculated by you and added to the request. See How to sign a request for more information.

action (required)

string

The API method that should be called. In this case the value should be edit-banner.

t (required)

timestamp

Specifies the current timestamp in seconds.

identifier (required)

string

A unique identifier for every user.
Examples: [email protected], 2AF832 etc.

banner_hash
(required)

string

The hash of the banner to be edited.
Examples: bh3yhqam, t5j4hjvk, etc.

Name

Type

Description

code

integer

The code will indicate the status of your request.
​code 200 represents an successful response.

url

string

The URL to the Bannersnack editor with the requested banner loaded for editing.

Name

Type

Description

client_id (required)

string

The client_id parameter is required for authentification. We associate the user to the client ID provided. Find out how can you obtain your client ID.

signature (required)

string

The signature must be calculated by you and added to the request. See How to sign a request for more information.

action (required)

string

The API method that should be called. In this case the value should be edit-bannerset.

t (required)

timestamp

Specifies the current timestamp in seconds.

identifier (required)

string

A unique identifier for every user.
Examples: [email protected], 2AF832 etc.

bannerset_hash
(required)

string

The hash of the bannerset to be edited.
Examples: bh3yhqam, t5j4hjvk, etc.

Name

Type

Description

code

integer

The code will indicate the status of your request.
​code 200 represents an successful response.

url

string

The URL to the Bannersnack generator with the requested banner loaded for editing.

Name

Type

Description

client_id (required)

string

The client_id parameter is required for authentification. We associate the user to the client ID provided. Find out how can you obtain your client ID.

signature (required)

string

The signature must be calculated by you and added to the request. See How to sign a request for more information.

action (required)

string

The API method that should be called. In this case the value should be get-banner-urls.

t (required)

timestamp

Specifies the current timestamp in seconds.

banner_hash (required)

string

The banner hash to get urls for.

Name

Type

Description

type

string

The type of file for which the url is returned.

url

string

The URL to the banner.

status

string

The status of the banner

Code

Message

Explanation

510

The request has expired

The request couldn't be completed. Check your server datetime.

511

Maintenance mode

The API servers have entered in maintenance mode and cannot complete any requests. In this case you should try again later.

512

Client id not found

Given Client ID is not found in the database.

513

Invalid signature

The signature you provided is incorrect - it does not match the request.

514

Bad request

Your request is incorrectly formatted or cannot be otherwise served.

515

Disabled domain

The domain you requested is disabled. You are not allowed to access the specified domain.

520

Missing mandatory parameter

The request does not contain one or more required parameters. There are 5 required parameters for this request: client_id, signature, action, banner_hash and t.

521

Internal server error

An error occurred on the server and the request could not be completed. In this case you should resend the request after a few seconds. If the request still fails after several attempts, please contact us.

531

Banner not found

You are trying to access a banner that does not exist or you don't have access to it.

Name

Type

Description

client_id (required)

string

The client_id parameter is required for authentification. We associate the user to the client ID provided. Find out how can you obtain your client ID.

signature (required)

string

The signature must be calculated by you and added to the request. See How to sign a request for more information.

action (required)

string

The API method that should be called. In this case the value should be get-bannerset-urls.

t (required)

timestamp

Specifies the current timestamp in seconds.

bannerset_hash (required)

string

The bannerset hash to get urls for.

Name

Type

Description

bannerHash

string

The hash of the banner from bannerset.
Examples: bh3yhqam, t5j4hjvk, etc.

urls

array

An array with 3 objects. Each object will have the following parameters:
​
typestringThe type of file for which the url is returned.

urlstringThe URL to the banner.statusstringThe status of the banner

Code

Message

Explanation

510

The request has expired

The request couldn't be completed. Check your server datetime.

511

Maintenance mode

The API servers have entered in maintenance mode and cannot complete any requests. In this case you should try again later.

512

Client id not found

Given Client ID is not found in the database.

513

Invalid signature

The signature you provided is incorrect - it does not match the request.

514

Bad request

Your request is incorrectly formatted or cannot be otherwise served.

515

Disabled domain

The domain you requested is disabled. You are not allowed to access the specified domain.

520

Missing mandatory parameter

The request does not contain one or more required parameters. There are 5 required parameters for this request: client_id, signature, action, bannerset_hash and t.

521

Internal server error

An error occurred on the server and the request could not be completed. In this case you should resend the request after a few seconds. If the request still fails after several attempts, please contact us.

531

Banner not found

You are trying to access a banner that does not exist or you don't have access to it.

Name

Type

Description

client_id (required)

string

The client_id parameter is required for authentification. We associate the user to the client ID provided. Find out how can you obtain your client ID.

signature (required)

string

The signature must be calculated by you and added to the request. See How to sign a request for more information.

action (required)

string

The API method that should be called. In this case the value should be get-user-banners.

t (required)

timestamp

Specifies the current timestamp in seconds.

identifier (required)

string

A unique identifier for every user.
Examples: [email protected], 2AF832 etc.

type

string

Banner type, one of: bannersets, banners(default) or all.

bannerset_hash

string

The bannerset hash.

Name

Type

Description

bannerHash

string

The hash of the banner that has been found.

name

string

The name of the banner.

image

string

The path of the banner.

dateCreated

timestamp

The date when the banner was created.

dateLastUpdate

timestamp

The last date when the banner was updated.

width

integer

The width of the banner.

height

integer

The height of the banner.

type

string

The type of the banner: bannerset or banner

numberOfBanners

string

The number of the banners from bannerset or null if the type is banner.

animated

bool

Returns true if the banner is animated.

exports

array

List of generated exports.

Code

Message

Explanation

510

The request has expired

The request couldn't be completed. Check your server datetime.

511

Maintenance mode

The API servers have entered in maintenance mode and cannot complete any requests. In this case you should try again later.

512

Client id not found

Given Client ID is not found in the database.

513

Invalid signature

The signature you provided is incorrect - it does not match the request.

514

Bad request

Your request is incorrectly formatted or cannot be otherwise served.

515

Disabled domain

The domain you requested is disabled. You are not allowed to access the specified domain.

520

Missing mandatory parameter

The request does not contain one or more required parameters. There are 5 required parameters for this request: client_id, signature, action, identifier and t.

521

Internal server error

An error occurred on the server and the request could not be completed. In this case you should resend the request after a few seconds. If the request still fails after several attempts, please contact us.

534

Identifier not found

You are trying to access banners from an identifier that does not exist.

Name

Type

Description

client_id (required)

string

The client_id parameter is required for authentification. We associate the user with the client ID provided. Find out how can you obtain your client ID.

signature (required)

string

The signature must be calculated by you and added to the request. See How to sign a request for more information.

action (required)

string

The API method that should be called. In this case the value should be start-banner-export.

t (required)

timestamp

Specifies the current timestamp in seconds.

banner_hash (required)

string

The banner hash.

type (required)

string

Export type, one of: mp4, pdf, pdf-print, animated-gif or optimized-animated-gif.

Name

Type

Description

status

string

The status of the request

Code

Message

Explanation

510

The request has expired

The request couldn't be completed. Check your server datetime.

511

Maintenance mode

The API servers have entered in maintenance mode and cannot complete any requests. In this case you should try again later.

512

Client id not found

Given Client ID is not found in the database.

513

Invalid signature

The signature you provided is incorrect - it does not match the request.

514

Bad request

Your request is incorrectly formatted or cannot be otherwise served.

515

Disabled domain

The domain you requested is disabled. You are not allowed to access the specified domain.

520

Missing mandatory parameter

The request does not contain one or more required parameters. There are 5 required parameters for this request: client_id, signature, action, banner_hash and t.

521

Internal server error

An error occurred on the server and the request could not be completed. In this case you should resend the request after a few seconds. If the request still fails after several attempts, please contact us.

530

Invalid format type

The resource you are trying to access must have a valid format.

531

Banner not found

You are trying to access a banner that does not exist or you don't have access to it.