Skip to content

Raptive Integration Doc

Tyler Cornell edited this page Feb 11, 2025 · 11 revisions

Raptive Integration Documentation

Features

  • Standard OpenRTB 2.5/2.6 compliant bidding protocol
  • Real-time bid request and response handling
  • Support for banner ad formats
  • Publisher ID validation through ads.txt
  • Secure HTTPS communication
  • Optional Support for targeting off Ad Refresh Rate (RTB 2.6)
    • Integration partners must provide a filled-out "Refresh" object for this

Request Flow

graph TD;
  A[Publisher] -->|Send Bid Request| B[Raptive];
  B -->|Forward Request| C[Chicory];
  C -->|Return Bid Response| B;
  B -->|Serve Ad Content| A;
Loading

Partner Setup Requirements

ads.txt Configuration

Publishers must add the following line to their ads.txt file:

chicoryapp.com, 1641021363254de6830750e1ca78e06d, DIRECT

API Endpoint Details


Base URL: https://prod-ssp.chicoryapp.com/bid/raptive

Protocol: HTTPS

HTTP Method: POST

** Content Type**:

JSON (OpenRTB-compliant standard ad request)

Required Parameters

Note: These are the parameters that must be filled out by the integration partner, Chicory, or a hybrid of both in order to deliver ads. Parameters with Partner Required: Yes must be sent by the integration partner to its assigned bidding endpoint. Parameters marked Partner Required: No mean it's still preferred for the integration partner to fill them out, but Chicory has the ability to force these values on its SSP to remain flexible for the integration.

Parameter Type Description Partner Required Info
imp[] Array Array containing impression objects Yes At least one valid imp object is required. See example below
imp[].banner Object Banner object specifying w/h details Yes Supported creative sizes are 300x250, 300x200, 300x90. See example below
imp[].tagid String Placement ID Yes Used for targeting placements
site.publisher.id String Publisher identifier No Must be Chicory Seller ID: 1641021363254de6830750e1ca78e06d
site.domain String Domain of the page Yes e.g "thecookingblog.com"
site.id String Site identifier No Raptive's Chicory-Assigned ID a6c7c5e00c8f4d2fa91c731c29989683

Example Request

Note: This is a partial request. Please fill out the standard OpenRTB request with as much detail as possible for downstream targeting.

{
  "id": "bid-request-123",
  "imp": [{
    "id": "536ca457b9b6446b",
    "banner": {
      "format": [
        { "w": 300, "h": 250 },
        { "w": 300, "h": 200 },
        { "w": 300, "h": 90 }
      ],
      "w": 300,
      "h": 250,
      "pos": 1
    },
    "tagid": "content_btf",
    "bidfloor": 0.41,
    "bidfloorcur": "USD",
    "secure": 1,
    "exp": 600,
    "ext": {
      "gpid": "/1030006,22511918254/kalejunkie/recipe"
    }
  }],
  "site": {
    "id": "a6c7c5e00c8f4d2fa91c731c29989683", <-- Chicory Assigned ID for Raptive
    "domain": "thecookingblog.com",
    "publisher": {
      "id": "1641021363254de6830750e1ca78e06d" <--- Chicory seller ID
    }
  }
}

Response Format


Content Type

JSON

Response Example

{
  "id": "bid-request-123",
  "seatbid": [{
    "bid": [{
      "id": "bid-123",
      "impid": "536ca457b9b6446b",
      "price": 1.25,
      "adm": "<div>...ad content...</div>",
      "crid": "creative-123",
      "dealid": "CHI-DEAL-RAPTIVE",
      "w": 300,
      "h": 250
    }]
  }],
  "bidid": "bid-response-123"
}

Field Descriptions

Field Type Description
id String Echo of the request ID
seatbid[].bid[].id String Unique bid identifier
seatbid[].bid[].impid String Impression ID from request
seatbid[].bid[].price Number Bid price in USD
seatbid[].bid[].adm String Ad markup
seatbid[].bid[].crid String Creative ID
seatbid[].bid[].dealid String Deal ID if applicable
seatbid[].bid[].w Number Width of the creative
seatbid[].bid[].h Number Height of the creative