Документация на партньорския API

401 INVALID_TOKEN

Няма активен токен, който да съответства на идентификационните данни Bearer, или токенът е отменен. Липсваща или неправилно форматирана заглавка Authorization също връща 401, но само крайната точка metrics я обозначава с този код. Токен SSP на партньорска крайна точка получава същия отговор.

{
  "error": "Invalid or revoked partner API token. This endpoint only accepts partner tokens, not SSP tokens.",
  "code": "INVALID_TOKEN"
}

{
  "error": "Invalid or revoked partner API token.",
  "code": "INVALID_TOKEN"
}

{
  "error": "Missing or invalid Authorization header. Expected: Bearer <token>",
  "code": "INVALID_TOKEN"
}

{
  "error": "Missing or invalid Authorization header. Expected: Bearer <token>"
}

403 PRO_PLAN_REQUIRED

Токенът е валиден, но издателят му не е с план Pro. Това се проверява преди обхвата, така че токен само за четене, принадлежащ на издател без план Pro, отчита грешка за плана, а не за обхвата.

{
  "error": "The Pro plan is required to use the partner API.",
  "code": "PRO_PLAN_REQUIRED"
}

403 INSUFFICIENT_SCOPE

Токенът е валиден и е с план Pro, но му липсва обхватът metrics:write, необходим за докладване на метрики.

{
  "error": "This token is not authorised to write metrics. Required scope: metrics:write.",
  "code": "INSUFFICIENT_SCOPE"
}

403 FORBIDDEN

Обявлението принадлежи на друг издател. Нищо не се записва.

{
  "error": "This advertisement belongs to a different publisher.",
  "code": "FORBIDDEN"
}

400 INVALID_METRICS

Тялото на заявката не е валиден JSON или двете числови стойности липсват, са отрицателни или не са цели числа. Отговорът посочва какво не е преминало проверката.

{
  "error": "Invalid engagement metrics",
  "code": "INVALID_METRICS",
  "issues": [
    {
      "path": "viewsCount",
      "message": "Too small: expected number to be >=0"
    }
  ]
}

{
  "error": "Invalid request body",
  "code": "INVALID_METRICS"
}

409 METRICS_NOT_APPLICABLE

Обявлението е извън обхвата, за който са определени метриките за ангажираност. Бележка 15 от приложение II обхваща онлайн или нативно обявление, при което са използвани техники за таргетиране или техники за доставяне на реклами и което вече е започнало да се показва. Нищо не се записва.

{
  "error": "Engagement metrics do not apply to this notice",
  "code": "METRICS_NOT_APPLICABLE"
}

404 NOT_FOUND

Няма обявление, което да съответства на този PA-ID, или то все още не е видимо за вас. Прочетете раздела по-горе, преди да приемете, че идентификаторът е грешен.

{
  "error": "Advertisement not found",
  "code": "NOT_FOUND"
}

{
  "error": "Advertisement not found"
}

{
  "error": "Advertisement not found or not yet confirmed"
}

429 RATE_LIMITED

Ограничението за токена е надвишено. Отговорът съдържа заглавките X-RateLimit-Limit, X-RateLimit-Remaining и X-RateLimit-Reset.

{
  "error": "Rate limit exceeded",
  "code": "RATE_LIMITED",
  "limit": 1000,
  "remaining": 0,
  "reset": "2026-05-14T15:14:00.000Z"
}

{
  "error": "Rate limit exceeded",
  "limit": 1000,
  "remaining": 0,
  "reset": "2026-05-14T15:14:00.000Z"
}

Машинно четима спецификация

Пълният документ OpenAPI 3.1 е достъпен на /api/docs. Насочете Postman, Swagger UI или генератор на клиенти директно към него, вместо да преписвате тази страница.