Enable Piggyback

Enables Piggyback functionality for the given Placement.

URL: /rest-api/piggyback/placement/enable.do

Method: POST

Response format: application/json

Error codes:

  • 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 for hash generation.
  • username – a given username.
  • id – the given Placement ID.

Disable Piggyback

Disables Piggyback functionality for the given Placement.

URL: /rest-api/piggyback/placement/disable.do

Method: POST

Response format: application/json

Error codes:

  • 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 for hash generation.
  • username – a given username.
  • id – the given Placement ID.

Save Piggyback

Saves Piggyback for the given Placement.

URL: /rest-api/piggyback/placement.do

Method: POST

Response format: application/json

Error codes:

  • 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 for hash generation.
  • username – a given username.
  • placementId – the given Placement ID.
  • type – Piggyback type (optional). Available values: BEACON (default), URL.
  • codeUrl – Piggyback URL or Code as a string (optional).

Get Piggyback

Get Piggyback for the given Placement.

URL: /rest-api/piggyback/get.do

Method: GET

Response format: application/json

Error codes:

  • 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 for hash generation.
  • username – a given username.
  • placementId – ID of the Placement; long value.

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.