RTB API

Using merchenta.io for real-time bidding

Supply-Side Platform 

Our API supoprts creating publisher account to display ads on registered adslots (Supply-Side Platform or SSP)

Save publisher 

/v3/ssp/publisher

Create or update publisher. PublisherId is a unique identifier. This method returns an error if publisher Id is already used by another publisher.

  • PublisherId is identifier for publisher account (eg BTELE for belfasttelegraph.co.uk).
  • Domain e.g. www.belfasttelegraph.co.uk
  • PublisherName is a name of publisher e.g. “MediaForce - Belfast Tele”. Minimum 5 characters.
  • Curl
  • Copy
    curl -i \ -X POST \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ -H 'Content-Type: application/json' \ -d '{ "publisherId": "MERCHENTA-test", "domain": "merchenta.com", "publisherName": "MERCHENTA" }' \ https://sandbox.rtbapi.io/v3/ssp/publisher
  • Request
  • Headers
    Authorization: Bearer {YOUR_TOKEN_HERE}
    Content-Type: application/json
    Example body
    {
        "publisherId": "MERCHENTA-test",
        "domain": "merchenta.com",
        "publisherName": "MERCHENTA"
    }
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
            "status": "success",
            "data": {
                "publisher": {
                    "publisherId": "MERCHENTA-test",
                    "publisherStatus": "ACTIVE",
                    "domain": "merchenta.com",
                    "publisherName": "MERCHENTA",
                    "username": "merchenta",
                    "createdDate": "2015-09-14",
                    "updatedDate": "2015-09-14"
                }
            }
        }

Retrieve publisher record 

/v3/ssp/publisher/{publisherId}

Retrieve publisher record that is owned by requested account.

  • Parameters
  • publisherId
    string (required) Example: MERCHENTA-test

    Unique publisher Id owned by request account

  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/ssp/publisher/MERCHENTA-test
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
            "status": "success",
            "data": {
                "publisher": {
                    "publisherId": "MERCHENTA-test",
                    "publisherStatus": "ACTIVE",
                    "domain": "merchenta.com",
                    "publisherName": "MERCHENTA",
                    "username": "merchenta",
                    "createdDate": "2015-09-14",
                    "updatedDate": "2015-09-14"
                }
            }
        }

Save adslot 

/v3/ssp/publisher/{publisherId}/adslot

Add or update an adslot.

  • AdslotId is unique identifier for the registering adslot.
  • PublisherId is identifier for publisher account (eg BTELE for belfasttelegraph.co.uk).
  • Width and height are the reference adslot size on publisher’s website.
  • Position is to indicate where in page or app it appears. Can be ATF (above the fold), BTF (below the fold), INT (interstitial), PRE (pre-roll), POST (post roll)
  • Formats are references of ads’ format. This value could be IMAGE (image ad), RICH (rich media, HTML5) or VAST (video)
  • IabCategoryIds are the references of category of ads that publisher want to show in the adslot.
  • Parameters
  • publisherId
    string (required) Example: MERCHENTA-test

    Unique publisher Id owned by request account

  • Curl
  • Copy
    curl -i \ -X POST \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ -H 'Content-Type: application/json' \ -d '{ "adslotId": "MERCHENTA-adslot-test", "publisherId": "MERCHENTA", "adslotName": "MERCHENTA-adslot-test", "width": 320, "height": 150, "position": "ATF", "formats": ["IMAGE"], "iabCategoryIds": [10,12] }' \ https://sandbox.rtbapi.io/v3/ssp/publisher/MERCHENTA-test/adslot
  • Request
  • Headers
    Authorization: Bearer {YOUR_TOKEN_HERE}
    Content-Type: application/json
    Example body
    {
        "adslotId": "MERCHENTA-adslot-test",
        "publisherId": "MERCHENTA",
        "adslotName": "MERCHENTA-adslot-test",
        "width": 320,
        "height": 150,
        "position": "ATF",
        "formats": ["IMAGE"],
        "iabCategoryIds": [10,12]
    }
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
            "status": "success",
            "data": {
                "adslot": {
                    "adslotId": "MERCHENTA-adslot-test",
                    "publisherId": "MERCHENTA",
                    "adslotStatus": "ACTIVE",
                    "adslotName": "MERCHENTA-adslot-test",
                    "width": 320,
                    "height": 150,
                    "position": "ATF",
                    "formats": ["IMAGE"],
                    "iabCategoryIds": [10,12],
                    "createdDate": "2015-09-14",
                    "updatedDate": "2015-09-14"
                }
            }
        }

Retrieve adslot 

/v3/ssp/publisher/{publisherId}/{adslotId}

Retrieve adslot by adslotId. The request adslotId must own by publisherId and publisherId must own by requested account.

  • Parameters
  • publisherId
    string (required) Example: MERCHENTA-test

    Unique publisher Id owned by request account

    adslotId
    string (required) Example: MERCHENTA-adslot

    Unique adslot Id owned by publisherId

  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/ssp/publisher/MERCHENTA-test/MERCHENTA-adslot
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
            "status": "success",
            "data": {
                "adslot": {
                    "adslotId": "MERCHENTA-adslot-test",
                    "publisherId": "MERCHENTA",
                    "adslotStatus": "ACTIVE",
                    "adslotName": "MERCHENTA-adslot-test",
                    "width": 320,
                    "height": 150,
                    "position": "ATF",
                    "formats": ["IMAGE"],
                    "iabCategoryIds": [10,12],
                    "createdDate": "2015-09-14",
                    "updatedDate": "2015-09-14"
                }
            }
        }
Next page  Previous page