Коротко о новом законе
Подключение к ОРД-А и работа в ЛК
Площадки
Контрагенты
Договоры
Креативы
Гайд по размещению (идентификатора) токена
Документация API
Статистика
Акты, разаллокация акта по ИД
Импорт/Экспорт Excel в ЛК
3.11 Статистика (Statistics)
3.11.1  Получение сведений о статистике:  GET /statistics
https://api.ord-a.ru/api/v2/statistics
Данный метод используется для получения списка статистики по креативам
Параметры запроса
Параметр Тип Обязательность Описание
page число нет Номер страницы
limit число нет Количество записей на странице
sort строка нет Используется при get запросе. Сортировка по столбцу. Допустимые значения: id, -id, amount, -amount, amount_per_show, -amount_per_show, date_end_fact, -date_end_fact, date_end_plan, -date_end_plan, date_start_fact, -date_start_fact, date_start_plan, -date_start_plan, imps_fact, -imps_fact, imps_plan, -imps_plan
Код ответа Описание
200 OK Положительный статус запроса
401 Unauthorized Доступ запрещен, невалидный токен
Пример запроса:
curl -X 'GET' \
  'https://api.ord-a.ru/api/v2/statistics' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  TOKEN' \
  -H 'X-CSRF-TOKEN: '
Пример ответа:
 {
  "data": [
    {
            "id": 91023,
            "is_partner": false,
            "membership_id": 1,
            "platform_id": 325673,
            "platform": {
                "id": 325673,
                "name": "Test"
            },
            "creative_id": 4959,
            "invoice_item_id": 1454,
            "invoice_item": {
                "id": 1454,
                "is_partner": false,
                "membership_id": 1,
                "invoice_id": 1641,
                "invoice": {
                    "id": 1641,
                    "number": "123"
                },
                "contract_id": 31647,
                "amount": 0,
                "is_vat": false,
                "contract": {
                    "id": 31647,
                    "number": null
                },
                "external_id": null,
                "deleted_at": null
            },
            "imps_plan": 0,
            "imps_fact": 0,
            "date_start_plan": "2023-12-13",
            "date_start_fact": "2023-12-13",
            "date_end_plan": "2023-12-13",
            "date_end_fact": "2023-12-13",
            "amount": "0",
            "amount_per_show": "0",
            "is_vat": false,
            "target_audience": null,
            "external_id": null,
            "created_at": "2024-02-20T14:45:55+03:00",
            "deleted_at": null
        },
        {
            "id": 91022,
            "is_partner": false,
            "membership_id": 1,
            "platform_id": 326399,
            "platform": {
                "id": 326399,
                "name": "NEST"
            },
            "creative_id": 5278,
            "invoice_item_id": null,
            "invoice_item": null,
            "imps_plan": 1,
            "imps_fact": 1,
            "date_start_plan": "2024-02-20",
            "date_start_fact": "2024-02-20",
            "date_end_plan": "2024-02-20",
            "date_end_fact": "2024-02-20",
            "amount": "1",
            "amount_per_show": "1",
            "is_vat": false,
            "target_audience": null,
            "external_id": null,
            "created_at": "2024-02-20T10:59:05+03:00",
            "deleted_at": null
        }
  ],
  "links": {
    "first": "https://api.ord-a.ru/api/v2/statistics?page=1",
    "last": "https://api.ord-a.ru/api/v2/statistics?page=1",
    "prev": null,
    "next": "https://api.ord-a.ru/api/v2/statistics?page=1"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Вперед",
        "active": false
      },
      {
        "url": "https://api.ord-a.ru/api/v2/statistics?page=1",
        "label": "1",
        "active": true
      }
    ],
    "path": "https://api.ord-a.ru/api/v2/statistics",
    "per_page": 1,
    "to": 2,
    "total": 2
  }
}
3.11.2  Получение сведений определенной статистики:  GET /statistics/{id}
 https://api.ord-a.ru/api/v2/statistics/{id}
Данный метод используется для получения определенной статистики по креативам
Параметры запроса
Параметр Тип Обязательность Описание
id число да идентификатор статистики
Код ответа Описание
200 OK Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Идентификатор статистики не найден
Пример запроса:
 curl -X 'GET' \
  'https://api.ord-a.ru/api/v2/statistics/2199701' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'X-CSRF-TOKEN: '
Пример ответа:
{
   "data": {
       "id": 415,
       "is_partner": false,
       "membership_id": 1,
       "erir_entity": {
           "id": 10440,
           "status": "Регистрация",
           "status_label": "registration",
           "last_item": {
               "id": 15129,
               "status": "Регистрация",
               "status_label": "registration",
               "errors": [],
               "message": null,
               "created_at": "2024-07-17T13:43:08+03:00",
               "pending_at": "2024-07-17T13:48:08+03:00",
               "status_changed_at": "2024-07-17T15:06:08+03:00"
           },
           "registered_at": null,
           "created_at": "2024-07-17T13:43:07+03:00"
       },
       "platform_id": 7735,
       "platform": {
           "id": 7735,
           "name": "cupiditate"
       },
       "creative_id": 457,
       "invoice_item_id": null,
       "invoice_item": null,
       "imps_plan": 0,
       "imps_fact": 0,
       "date_start_plan": "2024-07-15",
       "date_start_fact": "2024-07-15",
       "date_end_plan": "2024-07-17",
       "date_end_fact": "2024-07-17",
       "amount": "0",
       "amount_per_show": "0",
       "is_vat": false,
       "target_audience": null,
       "external_id": null,
       "created_at": "2024-07-17T13:43:07+03:00",
       "deleted_at": null
   }
}
3.11.3  Создание статистики:  POST /statistics
https://api.ord-a.ru/api/v2/statistics
Данный метод используется для добавления статистики по креативам.
Код ответа Описание
201 Created Статистика создана
401 Unauthorized Доступ запрещен, невалидный токен
422 Unprocessable Content Некорректный запрос
Пример запроса:
curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/statistics' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "platform_id": 649249,
  "creative_id": 204045,
  "invoice_item_id": 25971,
  "imps_plan": 10,
  "imps_fact": 10,
  "date_start_plan": "2024-05-02",
  "date_start_fact": "2024-05-02",
  "date_end_plan": "2024-05-10",
  "date_end_fact": "024-05-11",
  "amount": 13.12345,
  "amount_per_show": 1.00005,
  "is_vat": true,
  "external_id": "2!№;"
    }'
Пример ответа:
{
    "data": {
        "id": 2199702,
        "is_partner": false,
        "membership_id": 1,
        "platform_id": 649249,
        "platform": {
            "id": 649249,
            "name": "площадка тест"
        },
        "creative_id": 204045,
        "invoice_item_id": 25971,
        "invoice_item": {
            "id": 25971,
            "is_partner": false,
            "membership_id": 43,
            "invoice_id": 8109,
            "contract_id": 33270,
            "amount": 1999251.6,
            "is_vat": true,
            "contract": {
                "id": 33270,
                "number": "1 от 26.06"
            },
            "external_id": "111-4",
            "deleted_at": null
        },
        "imps_plan": 10,
        "imps_fact": 10,
        "date_start_plan": "2024-05-02",
        "date_start_fact": "2024-05-02",
        "date_end_plan": "2024-05-10",
        "date_end_fact": "2024-05-11",
        "amount": "13.12345",
        "amount_per_show": "1.00005",
        "is_vat": true,
        "target_audience": null,
        "external_id": "2!№;",
        "created_at": "2024-05-22T15:11:20+03:00",
        "deleted_at": null
    }
}
3.11.4  Обновление статистик:  PUT /statistics/{id}
https://api.ord-a.ru/api/v2/statistics/{id}
Данный метод используется для обновления определенной статистики по креативам.
Параметры запроса
Параметр Тип Обязательность Описание
id число да идентификатор статистики
Код ответа Описание
200 OK Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Идентификатор статистики не найден
422 Unprocessable Content Некорректный запрос
Пример запроса:
curl -X 'PUT' \
 ' https://api.ord-a.ru/api/v2/statistics/426' \
 -H 'accept: application/json' \
 -H 'Authorization: Bearer TOKEN' \
 -H 'Content-Type: application/json' \
 -H 'X-CSRF-TOKEN: ' \
 -d '{
 "creative_id": 455,
   "platform_id": 7741,
   "imps_plan": 0,
   "imps_fact": 0,
   "amount": 0,
   "amount_per_show": 0,
   "date_start_fact": "7/17/2024",
   "date_end_fact": "7/17/2024",
   "date_start_plan": "7/17/2024",
   "date_end_plan": "7/17/2024",
   "is_vat": false,
   "invoice_item_id": null
}'
Успешный ответ:
{
   "data": {
       "id": 426,
       "is_partner": false,
       "membership_id": 1,
       "platform_id": 7741,
       "platform": {
           "id": 7741,
           "name": "Площадка"
       },
       "creative_id": 455,
       "invoice_item_id": null,
       "imps_plan": 0,
       "imps_fact": 0,
       "date_start_plan": "2024-07-17",
       "date_start_fact": "2024-07-17",
       "date_end_plan": "2024-07-17",
       "date_end_fact": "2024-07-17",
       "amount": "0",
       "amount_per_show": "0",
       "is_vat": false,
       "target_audience": null,
       "external_id": null,
       "created_at": "2024-07-17T15:43:23+03:00",
       "deleted_at": null
   }
}   
3.11.5  Удаление статистики:  DELETE /statistics/{id}
https://api.ord-a.ru/api/v2/statistics/{id}
Данный метод используется для удаления определенной статистики по креативам.
Параметр Тип Обязательность Описание
id число да идентификатор статистики
Код ответа Описание
204 No Content Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Идентификатор статистики не найден
Пример запроса:
curl -X 'DELETE' \
  'https://api.ord-a.ru/api/v2/statistic/2199702' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'X-CSRF-TOKEN: '
3.11.6  Восстановление статистики:  GET /statistics/{id}/restore
 https://api.ord-a.ru/api/v2/statistics/{id}/restore
Данный метод используется  для  восстановления определенной статистики по креативам
Параметры запроса
Параметр Тип Обязательность Описание
id число да идентификатор статистики
Код ответа Описание
200 OK Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Идентификатор статистики не найден
Пример запроса:
curl -X 'GET' \
  'https://api.ord-a.ru/api/v2/statistics/2199702/restore' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'X-CSRF-TOKEN: '
Успешный ответ:
{
   "data": {
       "id": 426,
       "is_partner": false,
       "membership_id": 1,
       "platform_id": 7741,
       "creative_id": 455,
       "invoice_item_id": null,
       "imps_plan": 0,
       "imps_fact": 0,
       "date_start_plan": "2024-07-17",
       "date_start_fact": "2024-07-17",
       "date_end_plan": "2024-07-17",
       "date_end_fact": "2024-07-17",
       "amount": "0",
       "amount_per_show": "0",
       "is_vat": false,
       "target_audience": null,
       "external_id": null,
       "created_at": "2024-07-17T15:43:23+03:00",
       "deleted_at": null
   }
}
3.11.7  Массово добавить/обновить статистику:  POST /statistics/upsert
 https://api.ord-a.ru/api/v2/statistics/upsert
Данный метод используется  для  массового добавление/обновления статистики по креативам
Код ответа Описание
200 OK Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
422 Unprocessable Content Некорректный запрос
Пример запроса на создание:
curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/statistics/upsert' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "statistics": [
    {
    "platform_id": 645525,
    "creative_id": 203374,
    "invoice_item_id": 25756,
    "imps_plan": 100,
    "imps_fact": 100,
    "date_start_plan": "2024-02-01",
    "date_start_fact": "2024-02-01",
    "date_end_plan": "2024-02-26",
    "date_end_fact": "2024-02-26",
    "amount": 5000,
    "amount_per_show": 1,
    "is_vat": true,
    "external_id": "466"
    }
    ,
    {
    "platform_id": 645524,
    "creative_id": 203373,
    "imps_plan": 1000,
    "imps_fact": 1000,
    "date_start_plan": "2024-02-01",
    "date_start_fact": "2024-02-01",
    "date_end_plan": "2024-02-26",
    "date_end_fact": "2024-02-26",
    "amount": 50000,
    "amount_per_show": 5,
    "is_vat": true
    }
  ]
}'
Успешный ответ:
 {
    "data": [
        {
            "id": 2185686,
            "external_id": "466"
        },
        {
            "id": 2185687,
            "external_id": null
        }
    ],
    "message": "OK"
}
3.11.8 Массовое удаление статистики: POST /statistics/bulk/delete
https://api.ord-a.ru/api/v2/statistics/bulk/delete
Данный метод используется для массового удаления статистики
Код ответа Описание
204 No Content Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
422 Unprocessable Content Некорректный запрос
Пример запроса:
curl -X 'POST' \
'https://api.ord-a.ru/api/v2/statistics/bulk/delete' \
-H 'accept: application/json' \
-H 'Authorization: Bearer TOKEN' \
-H 'Content-Type: application/json' \
-H 'X-CSRF-TOKEN: ' \
-d '{
"ids": [
633, 631
]
}
'
3.11.9 Атрибуты объекта «Статистика» (Statistics)
Параметр Тип Обязательность Описание
id число да Идентификатор статистики
contract_id строка (255) да

Идентификатор креатива

Минимальная длина: 1
Максимальная длина: 255

Длина строки от 1 до 255, может содержать спец символы - и _, а также латинские буквы a-z и A-Z и цифры 0-9
platform_id строка (255) да

Идентификатор площадки

Минимальная длина: 1
Максимальная длина: 255

ДДлина строки от 1 до 255, может содержать спец символы - и _, а также латинские буквы a-z и A-Z и цифры 0-9
imps_fact число да

Количество показов фактическое

Целое положительное число или нулевое.
Если у креатива, к которому относится статистика, признак isNative равен true, то значение должно равняться 0.
imps_plan число да

Количество показов по акту

Целое положительное число или нулевое
Eсли у креатива, к которому относится статистика, признак isNative равен true, то значение должно равняться 0
date_start _fact дата в формате ГГГГ-мм-дд да Дата начала показов фактическая
  1. Дата должна быть не ниже, чем 01.01.1991
  2. Дата должна быть меньше или равна, чем дата окончания показов фактическая
  3. Дата должна быть меньше или равна текущей дате
  4. Если date_end_fact > 31.01.2024 и invoice_item_id заполнено (есть связь с пунктом акта), то date_end_fact и date_start_fact должны быть в рамках одного месяца
  5. Если invoice_item_id = null, то date_end_fact и date_start_fact должны быть в рамках одного месяца
  6. Если invoice_item_id заполнено, то date_start_fact должно быть позже либо равно start_date в invoices
date_end _fact дата в формате ГГГГ-мм-дд да Дата окончания показов фактическая
  1. Дата должна быть не ниже, чем 01.01.1991
  2. Дата должна быть больше или равна, чем дата начала показов фактическая
  3. Дата должна быть меньше или равна текущей дате
  4. Если date_end_fact > 31.01.2024 и invoice_item_id заполнено (есть связь с пунктом акта), то date_end_fact и date_start_fact должны быть в рамках одного месяца
  5. Если invoice_item_id = null, то date_end_fact и date_start_fact должны быть в рамках одного месяца
date_start _plan дата в формате ГГГГ-мм-дд да Дата начала показов по акту
  1. Дата должна быть не ниже, чем 01.01.1991
  2. Дата должна быть меньше или равна, чем дата окончания показов по акту
  3. Дата должна быть меньше или равна текущей дате
  4. Если date_end_plan > 31.01.2024 и invoice_item_id заполнено (есть связь с пунктом акта), то date_end_ plan и date_start_ plan должны быть в рамках одного месяца
  5. Если invoice_item_id = null, то date_end_plan и date_start_ plan должны быть в рамках одного месяца
date_end _plan дата в формате ГГГГ-мм-дд да Дата окончания показов по акту
  1. Дата должна быть не ниже, чем 01.01.1991
  2. Дата должна быть больше или равна, чем дата начала показов по акту
  3. Дата должна быть меньше или равна текущей дате
  4. Если date_end_plan > 31.01.2024 и invoice_item_id заполнено (есть связь с пунктом акта), то date_end_ plan и date_start_ plan должны быть в рамках одного месяца
  5. Если invoice_item_id = null, то date_end_plan и date_start_ plan должны быть в рамках одного месяца
amount число с плавающей запятой
Если передавать 5 знаков после запятой (0.00001), использовать тип строка		 да

Стоимость оказанных услуг

Положительные числа или нулевые
Формат: до пяти знаков после запятой, разделитель - точка
22.23456
Не может быть больше нуля, если Стоимость единицы оказания услуг равна нулю

Если у креатива, к которому относится статистика, признак isNative равен true и Стоимость единицы оказания услуг равна нулю, то значение может быть больше нуля.
amount_per _show число с плавающей запятой
Если передавать 5 знаков после запятой (0.00001), использовать тип строка		 да

Стоимость единицы оказания услуг

Положительные числа или нулевые
Формат: до пяти знаков после запятой, разделитель - точка
22.23456
Если у креатива, к которому относится статистика, признак isNative равен true, то значение должно равняться 0

Если деньги списываются за клик, то указывается стоимость клика.
Если деньги списываются за показы, то стоимость указывается за 1000 показов.
Если деньги списываются за действие, то стоимость указывается за какое-то действие.
type Строка (5) нет, станет обязательным с 01.10.24. Тип рекламной кампании.
Возможные значения:
other - Иное;
cpm - CPM;
cpc - CPC;
cpa - CPA.
is_vat булево да

Признак "с НДС"

Возможные значения: true / false
invoice_ item_id число нет

Идентификатор детализации акта по атрибутам изначального договора (пункта акта).

Если не передавать данное поле, то статистика по креативу сохранится без привязки к акту и изначальному договору.
external_id Строка (255) нет Учетный идентификатор в базе пользователя
include Строка нет Параметр получения статусов сущностей для GET запроса, значение – erirEntity пример использования: https://api.ord-a.ru/api/v2/statistics?include=erirEntity
В json ответе от сервера появятся данные (
...
"erir_entity": { "id": 10454,
"status": "Регистрация",
"status_label": "registration",
"last_item": {
"id": 15148,
"status": "Регистрация",
"status_label": "registration",
"errors": [],
"message": null,
"created_at": "2024-07-18T11:55:20+03:00",
"pending_at": "2024-07-18T12:00:20+03:00",
"status_changed_at": "2024-07-18T12:00:23+03:00"
},
"registered_at": null,
"created_at": "2024-07-18T11:55:19+03:00"
}
...
filter [option] нет

Параметр получения статусов сущностей для GET запроса

Параметр для поиска записей сущностей для GET запроса, допустимые значения: id, platform, creative_id, invoice_item_id, imps_fact, imps_plan, period_fact, period_plan, amount, amount_per_show, status (1, 2, 3, 4, 10), external_id.

Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[id]=4

Пример запроса для фильтра по периоду https://api.ord-a.ru/api/v2/statistics?filter[period_fact]=20.07.2023-22.07.2023
sort нет

Параметр получения статусов сущностей для GET запроса

Параметр для сортировки массива сущностей для GET запроса, допустимые значения: id, -id, amount, -amount, amount_per_show, -amount_per_show, date_end_fact, -date_end_fact, date_end_plan, -date_end_plan, date_start_fact, -date_start_fact, date_start_plan, -date_start_plan, imps_fact, -imps_fact, imps_plan, -imps_plan

Пример запроса - https://api.ord-a.ru/api/v2/ statistics?sort=amount
Параметр Описание
include Параметр для получения статусов сущностей для GET запроса, значение – erirEntity Пример использования: https://api.ord-a.ru/api/v2/statistics?include=erirEntity
В json ответе от сервера появятся данные (
...
"erir_entity":
{
…
"id": 1391519,
"errors": [],
"message": null,
"status": "Регистрация",
"status_label": "registration",
…
},
...
)
filter[id] Параметр для поиска записей сущностей для GET запроса по id,
Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[id]=454
filter[platform] Параметр для поиска записей сущностей для GET запроса по platform,
Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[platform]=Тест
filter[creative_id] Параметр для поиска записей сущностей для GET запроса по creative_id,
Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[creative_id]=1083403
filter [invoice_item_id] Параметр для поиска записей сущностей для GET запроса по invoice_item_id,
Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[invoice_item_id]=68845
filter[imps_fact] Параметр для поиска записей сущностей для GET запроса по imps_fact,
Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[imps_fact]=4
filter[imps_plan] Параметр для поиска записей сущностей для GET запроса по imps_plan,
Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[imps_plan]=4
filter[period_fact] Параметр для поиска записей сущностей для GET запроса по period_fact,
Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[period_fact]=20.07.2023-22.07.2023
filter[period_plan] Параметр для поиска записей сущностей для GET запроса по period_plan,
Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[period_plan]=20.07.2023-22.07.2023
filter[amount] Параметр для поиска записей сущностей для GET запроса по amount,
Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[amount]=40
filter [amount_per_show] Параметр для поиска записей сущностей для GET запроса по period_plan,
Пример запроса - https://api.ord-a.ru/api/v2/statistics/?filter[amount_per_show]=600
filter[external_id] Учетный идентификатор в базе пользователя
sort Параметр для сортировки массива сущностей для GET запроса, допустимые значения: id, -id, amount, -amount, amount_per_show, -amount_per_show, date_end_fact, -date_end_fact, date_end_plan, -date_end_plan, date_start_fact, -date_start_fact, date_start_plan, -date_start_plan, imps_fact, -imps_fact, imps_plan, -imps_plan.
Пример запроса - https://api.ord-a.ru/api/v2/ statistics?sort=amount
3.12  Связь креативов с разаллокацией актов по изначальным договорам (InvoiceItemCreative)
3.12.1  Список креативов, принадлежащих разаллокации актов:  GET  invoices/items/{id}/creatives
 https://api.ord-a.ru/api/v2/invoices/items/{id}/creatives
Данный метод используется для получения списка креативов по определенной разаллокации актов креативов.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор пункта акта
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Идентификатор пункта акта не найден
Пример запроса:
curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/invoices/items/1606/creatives' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
Пример ответа:
{
    "data": [
        {
            "id": 5458,
            "is_partner": false,
            "membership_id": 1,
            "is_media": true,
            "erid": "uNqH85",
            "name": null,
            "contract_id": 31739,
            "self_promotion_organization_id": null,
            "description": "туц",
            "campaign": "other",
            "campaign_name": null,
            "type": "video",
            "target_audience": "туц",
            "url": null,
            "is_social": false,
            "is_political": false,
            "is_native": false,
            "statistics_exists": null,
            "okveds": [],
            "external_id": null,
            "created_at": "2024-03-12T18:36:10+03:00",
            "published_at": null,
            "deleted_at": null
        }
    ],
    "links": {
        "first": "https://api.ord-a.ru/api/v2/invoices/items/1606/creatives?page=1",
        "last": "https://api.ord-a.ru/api/v2/invoices/items/1606/creatives?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Вперед",
                "active": false
            },
            {
                "url": "https://api.ord-a.ru/api/v2/invoices/items/1606/creatives?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Назад »",
                "active": false
            }
        ],
        "path": "https://api.ord-a.ru/api/v2/invoices/items/1606/creatives",
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}
3.12.2  Перезапись связей креативов с разаллокациями актов: POST invoices/items/{{invoices_item_id}}/creatives-sync
https://api.ord-a.ru/api/v2/invoices/items/{invoices_item_id}/creatives-sync
Используется для перезаписи связей креативов с разаллокациями актов. С помощью данного метода можно отвязать автоматически уже привязанные креативы и привязать новые.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор пункта акта
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
422 Unprocessable Content Некорректный запрос
Пример запроса:
curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/invoices/items/1111/creatives-sync' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
-d '{
  "creative_ids": [
    4412, 4248,4262
  ]
  }'
Пример ответа:
 {
      "message": "Успешно"
}
3.12.3  Привязать креативы к разаллокации актов:  POST /invoices/{invoices_item_id}/creatives-attach
 https://api.ord-a.ru/api/v2/invoices/items/{invoices_item_id}/creatives-attach
Данный метод используется для установки связей креативов с разаллокациями актов.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор пункта акта
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
422 Unprocessable Content Некорректный запрос
Пример запроса:
curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/invoices/items/1606/creatives-attach' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
-d '{
  "creative_ids": [
    5140
  ]
  }'
Пример ответа:
 {
    "message": "Успешно"
}
3.12.4  Удаление связей с разаллокациями актов:  POST /invoices/{invoices_item_id}/creatives-detach
https://api.ord-a.ru/api/v2/invoices/items/{invoices_item_id}/creatives-detach
Данный метод используется для разрыва связей с разаллокациями актов.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да Идентификатор разаллокации актов по креативам (идентификатор пункта акта)
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
422 Unprocessable Content Некорректный запрос
Пример запроса:
curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/invoices/items/1606/creatives-detach' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
-d '{
  "creative_ids": [
    4412, 4248,4262
  ]
  }'
Пример ответа:
 {
    "message": "Успешно"
}
3.12.5 Атрибуты объекта «разаллокации актов по креативам» (InvoiceItemCreative):
Параметр Тип Обязательность Описание
invoices_item_id число да Идентификатор разаллокации актов по креативам (идентификатор пункта акта)
creative_ids массив да Массив id креативов
3.13 Привязывание / отвязывание платформ к контрагенту (OrganizationPlatform)
3.13.1  Метод привязывания платформ к  контрагенту:  POST /organizations/{id}/attach
https://api.ord-a.ru/api/v2/organizations/1/attach
Данный метод используется для привязки платформ к организации.
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Идентификатор пункта акта не найден
422 Unprocessable Content Некорректный запрос
Пример запроса:
curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/organizations/14277/attach' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
 "ids": [
    326496, 326495
  ]
}'
Пример ответа:
 {
     "message": "Платформы успешно привязаны"
}
3.13.2  Метод отвязывания площадок от контрагента:  POST /organizations/{id}/detach
https://api.ord-a.ru/api/v2/organizations/{id}/detach
Данный метод используется для отвязывания платформ от организации.
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Контрагент не найден
Пример запроса:
curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/organizations/14277/detach' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "ids": [
    326496, 326495
  ]
}'
Пример ответа:
 {
     "message": "Платформы успешно привязаны"
}
 3.13.3 Атрибуты, используемые «OrganizationPlatform»:
Параметр Тип Обязательность Описание
id число да Идентификатор контрагентов
ids массив да Массив идентификаторов площадок
3.14 Метод ручной отправки в ERRIER (Erir)
3.14.1  Метод отправки:  POST /send-erir/{model_type}
https://api.ord-a.ru/api/v2/send-erir/{model_type}
Данный метод используется для переотправки данных в ЕРИР.
Код ответа Описание
200 ОК Запрос выполнен
401 Unauthorized Доступ запрещен, невалидный токен
422 Unprocessable Content Доступ запрещен
Пример запроса:
curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/send-erir/organization' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "model_ids": [
    83134
  ]
}'
Пример ответа:
{
  "message": "Очереди успешно созданы"
}
 3.14.2 Атрибуты,  используемые при отправке «Erir»:
Параметр Тип Обязательность Описание
model_type строка да model_type – тип отправляемой сущности. Допустимые значения - organization, platform, contract, creative, invoice, statistic
model_ids массив да Массив отправляемыx id – значений сущностей
3.15 Сравнительная таблица изменений версий V1 и V2
Тэг Метод Роут Реализовано в V1 Реализовано в V2
Auth POST /auth да да
Organizations GET /organizations да да
Organizations POST /organizations да да
Organizations GET /organizations /{id} да да
Organizations PUT /organizations /{id} да да
Organizations DELETE /organizations /{id} да да
Organizations GET /organizations /{id} /restore да да
Organizations POST /organizations /upsert да
Platforms GET /platforms да да
Platforms POST /platforms да да
Platforms GET /platforms /{id} да да
Platforms PUT /platforms /{id} да да
Platforms DELETE /platforms /{id} да да
Platforms GET /platforms /{id} /restore да да
Platforms POST /platforms /upsert да
Contracts GET /contracts да да
Contracts POST /contracts да да
Contracts GET /contracts /{id} да да
Contracts PUT /contracts /{id} да да
Contracts DELETE /contracts /{id} да да
Contracts GET /contracts /{id} /restore да да
Contracts POST /contracts /upsert да
Creatives GET /creatives да да
Creatives POST /creatives да да
Creatives GET /creatives /{id} да да
Creatives PUT /creatives /{id} да да
Creatives DELETE /creatives /{id} да да
Creatives GET /creatives /{id} /restore да да
Creatives POST /creatives /upsert да
CreativeItems GET /creatives /{creative_id} /items да
CreativeItems POST /creatives /{creative_id} /items да
CreativeItems GET /creatives /{creative_id} /items /{id} да
CreativeItems PUT /creatives /{creative_id} /items /{id} да
CreativeItems DELETE /creatives /{creative_id} /items /{id} да
CreativeItems GET /creatives /{creative_id} /items /{id} /restore да
CreativeItems GET /creatives /{creative_id} /items /insert да
Invoices GET /invoices да да
Invoices POST /invoices да да
Invoices GET /invoices /{id} да да
Invoices PUT /invoices /{id} да да
Invoices GET /invoices /{id} /restore да да
Invoices POST /invoices /upsert да
InvoiceCreatives GET /invoices /creatives да
InvoiceCreatives POST /invoices /creatives да
InvoiceCreatives GET /invoices /creatives /{id} да
InvoiceCreatives PUT /invoices /creatives /{id} да
InvoiceCreatives DELETE /invoices /creatives /{id} да
InvoiceCreatives GET /invoices /creatives /{id} /restore да
InvoiceItems GET /invoices /items да да
InvoiceItems POST /invoices /items да да
InvoiceItems GET /invoices /items /{id} да да
InvoiceItems PUT /invoices /items /{id} да да
InvoiceItems DELETE /invoices /items /{id} да да
InvoiceItems GET /invoices /items /{id} /restore да да
InvoiceItems POST /invoices /items /upsert да
Media GET /media /{model_type} /{model_id} да да
Media POST /media /{model_type} /{id} да да
Media PUT /media /user /{id} да да
Media DELETE /media /{id} да да
Erir POST /send-erir /{model_type} да да
OrganizationPlatform POST /organizations /{id} /attach да да
OrganizationPlatform POST /organizations /{id} /detach да да
Statistics GET /statistics да
Statistics POST /statistics да
Statistics GET /statistics /{id} да
Statistics PUT /statistics /{id} да
Statistics DELETE /statistics /{id} да
Statistics GET /statistics /{id} /restore да
Statistics POST /statistics /items /upsert да
InvoiceItemCreative GET /invoices /items /{id} /creatives да
InvoiceItemCreative POST /invoices /items /{id} /creatives-sync да
InvoiceItemCreative POST /invoices /items /{id} /creatives-attach да
InvoiceItemCreative POST /invoices /items /{id} /creatives-detach да
InvoiceItemCreative POST /invoices /items /{id} /creatives-attach-import да
InvoiceItemCreative POST /import /excel /invoice_item_ statistic да
UserMedia GET /user /media да
UserMedia POST /user /media да
UserMedia DELETE /user /media да
Вернуться в начало
Оглавление
3.15 Сравнительная таблица изменений версий V1 и V2
3.14 Метод ручной отправки в ERRIER (Erir)
3.13 Привязывание / отвязывание платформ к контрагенту (OrganizationPlatform)
3.12 Связь креативов с разаллокацией актов по изначальным договорам (InvoiceItemCreative)
3.11 Статистика (Statistics)
3.10 Детализация акта по атрибутам изначального договора (InvoiceItems)
3.9 Акты (Invoices)
3.8 Привязка медиафайлов к пользователю (UserMedia)
3.7 Сведения о текстовых данных и медиафайлах (CreativeItems)
3.6 Сведения о медиафайлах (Media)
3.5 Креативы (Creatives)
3.4 Договоры (Contracts)
3.3. Площадки (Platforms)
3.2. Контрагенты (Organizations)
3.1. Авторизация: POST /auth
3. Методы API
2. JWT Авторизация
1. Вводные данные
Подключение к API ОРД-А (V2)