Set Banner Pricing

Sets or updates the Pricing information by Banner ID.

URL: /rest-api/banner/{bannerId}/pricing.do
Method: POST
Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types for parameters or Banner with such ID doesn't exist.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Request Parameters:

  • price – Banner Pricing as a double.
  • paymentModel – payment model as a String, available values: REVENUE_SHARE, FIXED_PRICE.
  • pricingType – Pricing type as a String, available values: CPM, CPC, CPA.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.

Set Country Pricing

Update the Country Pricing information by Banner ID.

URL: /rest-api/banner/{bannerId}/pricing/{countryCode}.do
Method: POST
Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types for parameters, Banner with such ID doesn't exist, Country code doesn't exist, Banner Pricing disabled.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Request Parameters:

  • price – Banner Pricing as a double.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.
  • countryCode – ISO Country code. To pass multiple Country codes use: "UK, US, CA".

Update Country Pricing Batch

Update the Country Pricing information by Banner ID from CSV file.

URL: /rest-api/banner/{bannerId}/pricing/batch
Method: POST
Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., wrong types for parameters, Banner with such ID doesn't exist, Banner Pricing disabled.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Request Parameters:

  • countryPrices – CSV–formatted file with Prices by Countries.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.

Get Pricing

Get the Pricing information by Banner ID.

URL: /rest-api/banner/{bannerId}/pricing.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – no Pricing for given Banner.

Response sample:
200 OK
{id: 1, paymentModel: "CPM", price: 0.03, countries: [{country: "US", price: 0.02}, {country: "UK", price: 0.025}, ... }

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.

Disable Banner Pricing

Disables Pricing by Banner ID.

URL: /rest-api/banner/{bannerId}/pricing.do
Method: DELETE
Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format, Banner with such ID doesn't exist.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.

Disable Banner Country Pricing

Disables Country Pricing by Banner ID.

URL: /rest-api/banner/{bannerId}/pricing/{countryCode}.do
Method: DELETE
Response format: application/json

Error codes:

  • 400 Bad Request – wrong request format. E.g., Banner with such ID doesn't exist or Banner Pricing is disabled.
  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • bannerId – the given Banner ID.
  • countryCode – ISO Country code. To pass multiple Country codes use: "UK, US, CA".

Need more help?

Should you require any additional help with our solutions, do not hesitate to contact Epom technical support at support@epom.com. Our support managers are dedicated to resolving any issues and providing you with solutions and support if you face difficulties or have questions.