Get Ad Service Domain

Returns all configured Ad Service Domains for the network.

URL: /rest-api/adsHosts.do
Method: GET
Response format: application/json

Response sample:
200 OK
["host1", "hostN".]

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.

Allow Changing Ad Service Domain

Allows changing adServiceDomain. Required permissions:

  • UPDATE permission for INVENTORY set to ALL or SHARED.
  • Set Ad Serving Domain (Inventory) permission set to ENABLED.

URL: /rest-api/sites/{siteId}/changeAdServingDomain.do
Method: POST
Response format: application/json

Response sample:
200 OK
{"id":1, "name":"someName", "adsHost":"default"}

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – permission violation.
  • 404 Not found – site of domain not found.

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.
  • siteId – ID of the given Site.
  • host – Ads host to use. If null is passed, the domain will be reset to system default.

Get Invocation Code Domains

Returns all configured Invocation Code Domains for the network.

URL: /rest-api/invocationCodeHosts.do
Method: GET
Response format: application/json

Response sample:
200 OK
["host1", "hostN".]

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.

Allow Changing Invocation Code Domain

Allows changing invocationCode domain. Required permissions:

  • UPDATE permission for INVENTORY set to ALL or SHARED.
  • Set Invocation Code Domain permission set to ENABLED.

URL: /rest-api/sites/{siteId}/changeInvocationCodeDomain.dobr /> Method: POST
Response format: application/json

Response sample:
200 OK
{"id":1, "name":"someName", "invocationCodeHost":null}

Error codes:

  • 401 Unauthorized – authentication error.
  • 404 Not found – site of domain not found.
  • 403 Forbidden – permission violation.

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.
  • siteId – ID of the given Site.
  • host – Ads host to use. If null is passed, the domain will be reset to system default.

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.