v1

latestOpenAPI 3.0.22026-07-146916.1 KB

GDPR TCF vendor list

Vendor URL mapping

Intended to be used by publishing systems to help determine if a vendor URL has been defined appropriately in the Sourcepoint system. This API can help developers that are integrating with Content Management Systems (CMS) verify that a URL referenced in content can be related to vendor and purpose consent preferences which can be queried and set based on user actions.<br><br>Before utilizing this API, ensure vendor URL mappings are configured for the vendor in the Sourcepoint portal.

post/vendor-list/vendor-url-mapping

Query parameters

allCategoryMappingboolean

Will return categoryMapping array which details all vendors and their configured purposes for the property

Request body

siteIdstring required

Property ID for the property in the Sourcepoint portal.

vendorUrlsstring[] required

Array of URLs to be matched against

Example request

{
  "vendorUrls": [
    "www.sourcepoint.com"
  ]
}

Response

Success

Example response

{
  "vendorUrlMapping": [
    {
      "url": "www.sourcepoint.com",
      "matchPattern": [
        {
          "ruleBoolean": true,
          "type": "CONTAINS",
          "urlPattern": "sourcepoint.com"
        }
      ],
      "rules": [
        {
          "patterns": [
            {
              "ruleBoolean": true,
              "type": "CONTAINS",
              "urlPattern": "sourcepoint.com"
            }
          ]
        }
      ],
      "vendorId": "5f23e826b8e05c0c0d4fdb8f",
      "vendorType": "IAB",
      "iabId": 590,
      "name": "Sourcepoint Technologies, Inc. (non-CMP)",
      "description": "Description example for the vendor",
      "policyUrl": "https://www.sourcepoint.com/privacy-notice/",
      "purposes": [
        {
          "id": "5fdbbcdf4f3f9789140e23a0",
          "type": "CONSENT"
        }
      ]
    }
  ],
  "categoryMapping": [
    {
      "vendorId": "23452fbeb8e05c3057240f85",
      "categories": [
        {
          "id": "5fd7e01e32bd4d27654ba1d5",
          "type": "LEGITIMATE_INTEREST"
        }
      ]
    }
  ]
}