О компании
Новости
Регистрация
Помощь
Контакты
Документы
3.5 Креативы (Creatives)
3.5.1  Получение списка креативов:  GET / сreatives
https://api.ord-a.ru/api/v2/creatives
Данный метод используется для получения списка креативов.
Параметры запроса:
Параметр Тип Обязательность Описание
page число нет Номер страницы
limit число нет Количество записей на странице
sort строка нет Используется при get запросе. Сортировка по столбцу. Допустимые значения: id, -id, name, -name, type, -type, campaign, campaign
Код ответа Описание
200 ОК Положительный статус запроса
401 Unauthorized Доступ запрещен, невалидный токен
Пример запроса:
curl -X 'GET' \
  'https://api.ord-a.ru/api/v2/creatives' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  TOKEN' \
  -H 'X-CSRF-TOKEN: '
Успешный ответ:
  "data": [
        {
            "id": 5282,
            "is_partner": false,
            "membership_id": 1,
            "erid": "uNqDUC",
            "name": null,
            "contract_id": 32206,
            "contract": {
                "id": 32206,
                "number": "1 от 27.02 Измененный"
            },
            "self_promotion_organization_id": null,
            "description": "Креатив изменен с целью демонстрации работы api",
            "campaign": "cpa",
            "campaign_name": "Тестовый креатив",
            "type": "other",
            "target_audience": "Текст",
            "url": [
                "http://test.ru"
            ],
            "is_social": true,
            "is_political": true,
            "is_native": false,
            "statistics_exists": false,
            "okveds": [],
            "external_id": "2134",
            "created_at": "2024-02-28T11:27:13+03:00",
            "published_at": null,
            "deleted_at": null
        },
        {
            "id": 5281,
            "is_partner": false,
            "membership_id": 1,
            "erid": "uNqDPn",
            "name": null,
            "contract_id": 31739,
            "contract": {
                "id": 31739,
                "number": "1"
            },
            "self_promotion_organization_id": null,
            "description": "описание объекта",
            "campaign": "other",
            "campaign_name": "название",
            "type": "video",
            "target_audience": "описание аудиотории",
            "url": null,
            "is_social": true,
            "is_political": true,
            "is_native": true,
            "statistics_exists": false,
            "okveds": [
                {
                    "code": "29.11.2"
                }
            ],
            "external_id": null,
            "created_at": "2024-02-22T14:44:47+03:00",
            "published_at": "2024-02-18",
            "deleted_at": null
        }  ],
  "links": {
    "first": "https://api.ord-a.ru/api/v2/creatives?page=1",
    "last": "https://api.ord-a.ru/api/v2/creatives?page=2",
    "prev": null,
    "next": "https://api.ord-a.ru/api/v2/creatives?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Вперед",
        "active": false
      },
      {
        "url": "https://api.ord-a.ru/api/v2/creatives?page=1",
        "label": "1",
        "active": true
      }
    ],
    "path": " https://api.ord-a.ru/api/v2/creatives",
    "per_page": 2,
    "to": 2,
    "total": 2
  }
}
3.5.2  Получение определенного креатива:  GET / сreatives/{id}
https://api.ord-a.ru/api/v2/creatives/{id}
Данный метод используется для получения определенного креатива.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор креатива
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен
404 Not found Идентификатор креатива не найден
Пример запроса:
curl -X 'GET' \
  'https://api.ord-a.ru/api/v2/creatives/5282' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  TOKEN' \
  -H 'X-CSRF-TOKEN: '
Успешный ответ:
  {
    "data": {
        "id": 5282,
        "is_partner": false,
        "membership_id": 1,
        "erir_entity": {
            "id": 44389,
            "message": null,
            "status": "Ожидание данных",
            "status_label": "pending_data",
            "payload": {
                "id": 5282,
                "url": [
                    {
                        "creativeUrl": "http://test.ru"
                    }
                ],
                "erid": "uNqDUC",
                "form": "other",
                "type": "cpa",
                "report": {
                    "reporterId": 12937,
                    "createdDatetimeInOrd": "2024-02-28 22:27:13.000000",
                    "updatedDatetimeInOrd": "2024-02-28 22:30:04.000000"
                },
                "isNative": false,
                "isSocial": true,
                "contractId": [
                    32206
                ],
                "description": "Креатив изменен с целью демонстрации работы api",
                "isPolitical": true,
                "creativeData": [],
                "creativeType": "creative",
                "creativeOkveds": [
                    "00.00"
                ],
                "targetAudience": "Текст",
                "targetAudienceList": null,
                "selfPromotionOrganizationId": null
            },
            "created_at": "2024-02-28T11:27:13+03:00",
            "pending_at": "2024-02-28T11:42:13+03:00"
        },
        "erid": "uNqDUC",
        "name": null,
        "contract_id": 32206,
        "contract": {
            "id": 32206,
            "number": "1 от 27.02 Измененный"
        },
        "self_promotion_organization_id": null,
        "self_promotion_organization": null,
        "description": "Креатив изменен с целью демонстрации работы api",
        "campaign": "cpa",
        "campaign_name": "Тестовый креатив",
        "type": "other",
        "target_audience": "Текст",
        "url": [
            "http://test.ru"
        ],
        "is_social": true,
        "is_political": true,
        "is_native": false,
        "statistics_exists": false,
        "okveds": [],
        "external_id": "2134",
        "created_at": "2024-02-28T11:27:13+03:00",
        "published_at": null,
        "deleted_at": null
    }
}
3.5.3 Создание креатива:  POST / creatives
https://api.ord-a.ru/api/v2/creatives
Данный метод используется для добавления креатива.
Код ответа Описание
201 Created Креатив создан
401 Unauthorized Доступ запрещен, невалидный токен
422 Unprocessable Content Некорректный запрос
Пример запроса:
curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/creatives' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer   TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "contract_id": 32206,
  "description": "Креатив создан с целью демонстрации работы api",
  "campaign": "cpa",
  "campaign_name": "Тестовый креатив",
  "type": "other",
  "target_audience": "Текст",
  "url": [
    "http://test.ru"
  ],
  "is_social": true,
  "is_political": true,
  "okveds": [
    "12.00"
  ],
  "external_id": "234"
}'
Успешный ответ:
 {
    "data": {
        "id": 5282,
        "is_partner": false,
        "membership_id": 1,
        "erid": "uNqDUC",
        "name": null,
        "contract_id": 32206,
        "contract": {
            "id": 32206,
            "number": "1 от 27.02 Измененный"
        },
        "self_promotion_organization_id": null,
        "self_promotion_organization": null,
        "description": "Креатив создан с целью демонстрации работы api",
        "campaign": "cpa",
        "campaign_name": "Тестовый креатив",
        "type": "other",
        "target_audience": "Текст",
        "url": [
            "http://test.ru"
        ],
        "is_social": true,
        "is_political": true,
        "is_native": false,
        "statistics_exists": null,
        "okveds": [
            {
                "code": "12.00"
            }
        ],
        "external_id": "234",
        "created_at": "2024-02-28T11:27:13+03:00",
        "published_at": null,
        "deleted_at": null
    }
}
3.5.4  Обновление креатива:  PUT / сreatives/{id}
https://api.ord-a.ru/api/v2/creatives/{id}
Данный метод используется для обновления определенного креатива по его id.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор креатива
Код ответа Описание
200 ОК Запрос выполнен
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Идентификатор креатива не найден
422 Unprocessable Content Некорректный запрос
Пример запроса:
curl -X 'PUT' \
  'https://api.ord-a.ru/api/v2/creatives/5282' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "contract_id": 32206,
  "description": "Креатив изменен с целью демонстрации работы api",
  "campaign": "cpa",
  "campaign_name": "Тестовый креатив",
  "type": "other",
  "target_audience": "Текст",
  "url": [
    "http://test.ru"
  ],
  "is_social": true,
  "is_political": true,
  "okveds": null,
  "external_id": "2134"
}'
Успешный ответ:
 {
    "data": {
        "id": 5282,
        "is_partner": false,
        "membership_id": 1,
        "erir_entity": {
            "id": 44389,
            "message": null,
            "status": "Ожидание данных",
            "status_label": "pending_data",
            "payload": {
                "id": 5282,
                "creativeType": "creative",
                "contractId": [
                    32206
                ],
                "selfPromotionOrganizationId": null,
                "description": "Креатив изменен с целью демонстрации работы api",
                "type": "cpa",
                "form": "other",
                "url": [
                    {
                        "creativeUrl": "http://test.ru"
                    }
                ],
                "creativeOkveds": [
                    "00.00"
                ],
                "creativeData": [],
                "isSocial": true,
                "isPolitical": true,
                "isNative": false,
                "targetAudience": "Текст",
                "targetAudienceList": null,
                "erid": "uNqDUC",
                "report": {
                    "reporterId": 12937,
                    "createdDatetimeInOrd": "2024-02-28 22:27:13.000000",
                    "updatedDatetimeInOrd": "2024-02-28 22:30:04.000000"
                }
            },
            "created_at": "2024-02-28T11:27:13+03:00",
            "pending_at": "2024-02-28T11:42:13+03:00"
        },
        "erid": "uNqDUC",
        "name": null,
        "contract_id": 32206,
        "contract": {
            "id": 32206,
            "number": "1 от 27.02 Измененный"
        },
        "self_promotion_organization_id": null,
        "self_promotion_organization": null,
        "description": "Креатив изменен с целью демонстрации работы api",
        "campaign": "cpa",
        "campaign_name": "Тестовый креатив",
        "type": "other",
        "target_audience": "Текст",
        "url": [
            "http://test.ru"
        ],
        "is_social": true,
        "is_political": true,
        "is_native": false,
        "statistics_exists": null,
        "okveds": [],
        "external_id": "2134",
        "created_at": "2024-02-28T11:27:13+03:00",
        "published_at": null,
        "deleted_at": null
    }
}
3.5.5  Удаление креатива:  DELETE /сreatives/{id}
https://api.ord-a.ru/api/v2/creatives/{id}
Данный метод используется для удаления определенного креатива по его id.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор креатива
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Идентификатор креатива не найден
Пример запроса:
curl -X 'DELETE' \
  'https://api.ord-a.ru/api/v2/creatives/1' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  TOKEN' \
  -H 'X-CSRF-TOKEN: '
3.5.6  Восстановление креатива:  GET / сreatives/{id}/restore
https://api.ord-a.ru/api/v2/creatives/{id}/restore
Данный метод используется для восстановления определенного креатива по его id.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор креатива
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Идентификатор креатива не найден
Пример запроса:
curl -X 'GET' \
  'https://api.ord-a.ru/api/v2/creatives/1/restore' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  TOKEN' \
  -H 'X-CSRF-TOKEN: '
3.5.7  Массовое добавление, обновление креативов:  POST  /creatives/upsert
https://api.ord-a.ru/api/v2/creatives/upsert
Данный метод используется для массового добавления/обновления креативов.
Код ответа Описание
200 ОК Запрос выполнен
401 Unauthorized Доступ запрещен, невалидный токен
422 Unprocessable Content Некорректный запрос
Пример запроса на создание креативов:
curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/creatives/upsert' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "creatives": [
    {
      "contract_id": 32834,
      "description": "Креатив 1 с целью демонстрации работы api",
      "campaign": "cpm",
      "campaign_name": "Тестовый креатив 1",
      "type": "other",
      "target_audience": "Текст",
      "url": [
        "http://test.ru"
      ],
      "is_social": true,
      "is_political": true,
      "okveds": [
        "12.00"
      ],
      "external_id": "3"
    },
    {
      "contract_id": 32820,
      "description": "Креатив 2 с целью демонстрации работы api",
      "campaign": "cpa",
      "campaign_name": "Тестовый креатив 2",
      "type": "other",
      "target_audience": "Текст",
      "url": [
        "http://test.ru"
      ],
      "is_social": false,
      "is_political": false,
      "okveds": null,
      "external_id": "1"
    }
  ]
}'
Успешный ответ:
 {
    "data": [
        {
            "id": 203373,
            "external_id": "3"
        },
        {
            "id": 203374,
            "external_id": "1"
        }
    ],
    "message": "OK"
}
3.5.8 Атрибуты объекта креативы (creatives):
Параметр Тип Обязательность Описание
contract_id число Условно обязательно Идентификатор договора (отсылка к ранее зарегистрированному договору/доп.соглашению), в случае саморекламы передается NULL
self_promotion _organization_id число Условно обязательно Обязательно в случае, если креатив является саморекламой. Указывается id организации - владельца
description строка (1000) да Общее описание объекта рекламирования
campaign строка (255) да Тип рекламной компании.
Возможные значения:
other - Иное;
cpm - CPM;
cpc - CPC;
cpa - CPA.
campaign _name строка (255) нет Название рекламной кампании
published_at дата (date) да Дата добавления
type строка (255) да

Тип распространения рекламы.

Возможные значения:
video - Видеоролик;
text-graphic-block - Текстово-графический блок;
text-block - Текстовый блок;
other - Иное;
live-video - Видеотрансляция в прямом эфире;
live-audio - Аудиотрансляция в прямом эфире;
banner - Баннер;
audio-rec - Аудиозапись.
url массив строк (2000) нет

Целевая ссылка (URL)

URL должен содержать протокол http|https|ftp|sftp
Если у креатива отсутствует целевая ссылка, то передавать данный массив не нужно!
is_social булево нет Признак социальной рекламы
is_political булево нет Признак политической рекламы
is_native булево да Признак нативной рекламы
okveds массив строк (255) нет

Коды ОКВЭД для объекта рекламирования (длина значения ОКВЭД должна составлять от 3 до 6 символов)

Если не указывается, в ЕРИР отправляется 00.00 (проставляется нами автоматом)
target _audience строка (255) да Параметры целевой аудитории рекламы
external_id строка (255) да Учетный идентификатор в базе пользователя
limit число нет Используется при get запросе. Количество записей при пагинации на странице.
page число нет Используется при get запросе. Номер страницы при пагинации на странице
sort строка нет Используется при get запросе. Сортировка по столбцу. Допустимые значения: id, -id, name, -name, type, -type, campaign, campaign
include Строка нет

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

(https://api.ord-a.ru/api/v2/creatives?include=lastEntity)
В json ответе от сервера появятся данные (
...
"erir_entity":
{
"message": "",
"status": "В очереди на отправку"
},
...
)
filter[option] строка нет

Параметр для поиска записей сущностей для GET запроса, допустимые значения - id, idNumber, name, erid, type, contract-type, campaign, contract, contract_id, created_at, campaign_name, url.

Для фильтра type доступные значения - audio-rec, banner, live-audio, live-video, text-block, text-graphic-block, video, other.

Для фильтра contract-type доступные значения - contract, intermediary-contract, additional-agreement, self-promotion.

Для фильтра campaign доступные значения - cpa, cpc, cpm, other.
Пример запроса - https://api.ord-a.ru/api/v2/creatives /? filter[id]=4
3.6 Сведения о медиафайлах (Media)
3.6.1  Получение списка загруженных медиафайлов в модель:  GET /media/creative/{id}
https://api.ord-a.ru/api/v2/media/creative/{id}
Данный метод используется для получения списка загруженных медиафайлов в креатив.
Не поддерживает текстовый блок. Можно использовать при необходимости метод, описанный в 3.7.3.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор креатива
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Креатив не найден
Пример запроса:
curl -X 'GET' \
  'https://api.ord-a.ru/api/v2/media/creative/4822' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'X-CSRF-TOKEN: '
Пример ответа:
{
    "data": [
        {
            "id": 373,
            "external_id": null,
            "media": {
                "id": 5244,
                "name": "0_7c779_5df17311_orig.jpg",
                "mime_type": "image/jpeg",
                "collection_name": "default",
                "url": "https://api.ord-a.ru/storage/media/04-10-2023/8328c6d2-b642-4808-8ca5-db39627585ee/0_7c779_5df17311_orig.jpg",
                "disk": "media",
                "created_at": "2023-10-04T11:39:43.000000Z"
            },
            "text_data": null,
            "created_at": "2023-10-04T14:39:43+03:00"
        },
        {
            "id": 374,
            "external_id": null,
            "media": {
                "id": 5245,
                "name": "road_sign_361513_960_720.jpg",
                "mime_type": "image/jpeg",
                "collection_name": "default",
                "url": "https://api.ord-a.ru/storage/media/04-10-2023/a3d234b6-1683-40ff-bfba-d21dc5db87e4/road_sign_361513_960_720.jpg",
                "disk": "media",
                "created_at": "2023-10-04T11:42:04.000000Z"
            },
            "text_data": null,
            "created_at": "2023-10-04T14:42:04+03:00"
        },
        {
            "id": 375,
            "external_id": null,
            "media": {
                "id": 5246,
                "name": "road_sign_361513_960_720.jpg",
                "mime_type": "image/jpeg",
                "collection_name": "default",
                "url": "https://api.ord-a.ru/storage/media/06-10-2023/c1ea67bb-43b1-445f-bf4e-7b926bc582d2/road_sign_361513_960_720.jpg",
                "disk": "media",
                "created_at": "2023-10-06T07:18:09.000000Z"
            },
            "text_data": null,
            "created_at": "2023-10-06T10:18:09+03:00"
        }
    ],
    "links": {
        "first": "https://api.ord-a.ru/api/v2/media/creative/4822?page=1",
        "last": "https://api.ord-a.ru/api/v2/media/creative/4822?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/media/creative/4822?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Назад »",
                "active": false
            }
        ],
        "path": "https://api.ord-a.ru/api/v2/media/creative/4822",
        "per_page": 15,
        "to": 3,
        "total": 3
    }
}
3.6.2  Добавление медиафайла в модель:  POST /media/creative/{id}
https://api.ord-a.ru/api/v2/media/creative/{id}
Данный метод используется для добавления медиафайла в модель.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор креатива
Код ответа Описание
201 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
422 Unprocessable Content Некорректный запрос
Пример запроса при добавлении медиафайла по ссылке:
curl -X 'POST' \
'https://api.ord-a.ru/api/v2/media/creative/1' \
-H 'accept: application/json' \
-H 'Authorization: Bearer TOKEN' \
-H 'Content-Type: application/json' \
-H 'X-CSRF-TOKEN: ' \
-d '{
"media_url": [
"https://www.aokmo.ru/upload/iblock/89c/ road_sign_361513_960_720.jpg"
]
}
Пример запроса при добавлении медиафайла с типом данных multipart/form-data:
curl --location 'https://api.ord-a.ru/api/v2/media/creatives/4412' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer  TOKEN' \
--form 'media=@"/D:/Work/ORD/pictures/0_7c779_5df17311_orig.jpg"'
Пример ответа:
{
    "message": "Файл отправлен!"
}
3.6.3 Удаление загруженного медиафайла:  DELETE /media/{id}
https://api.ord-a.ru/api/v2/media/{id}
Данный метод используется для удаления медиафайла из креатива.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор медиа
Код ответа Описание
204 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not Found Файл не найден
Пример запроса:
curl -X 'DELETE' \
  'https://api.ord-a.ru/api/v2/media/6028' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
3.6.4 Атрибуты объекта «Media» (Media):
Параметр Тип Обязательность Описание
id число да
xml file нет Xml файл
media_url linc нет Ссылка (url) на объект загрузки
media array file нет Массив файлов для загрузки
external_id строка (255) нет Учетный идентификатор в базе пользователя
3.7  Сведения о текстовых данных и медиафайлах (CreativeItems)
3.7.1  Получение списка загруженных медиафайлов и текстовых данных в креативе:  GET /creatives/{creative_id}/items
https://api.ord-a.ru/api/v2/creatives/{creative_id}/items
Данный метод используется для получения списка загруженных медиафайлов в модель.
Параметры запроса:
Параметр Тип Обязательность Описание
creative_id число да идентификатор креатива
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
403 Forbidden Ошибка
Пример запроса:
curl -X 'GET' \
  'https://api.ord-a.ru/api/v2/creatives/5291/items' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'X-CSRF-TOKEN: '
Пример ответа:
 {
    "data": [
        {
            "id": 707,
            "external_id": null,
            "media": {
                "id": 6030,
                "name": "road_sign_361513_960_720.jpg",
                "mime_type": "image/jpeg",
                "collection_name": "default",
                "url": "https:/api.ord-a.ru/storage/media/04-03-2024/2d58f4bd-d497-4b55-bec6-b9868743a69e/road_sign_361513_960_720.jpg",
                "disk": "media",
                "created_at": "2024-03-04T18:33:04.000000Z"
            },
            "text_data": null,
            "created_at": "2024-03-04T21:33:03+03:00"
        },
        {
            "id": 708,
            "external_id": null,
            "media": null,
            "text_data": "тест",
            "created_at": "2024-03-04T21:46:15+03:00"
        }
    ],
    "links": {
        "first": "http://api.ord-a.ru/api/v2/creatives/5291/items?page=1",
        "last": "http://api.ord-a.ru/api/v2/creatives/5291/items?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Вперед",
                "active": false
            },
            {
                "url": "http://api.ord-a.ru/api/v2/creatives/5291/items?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Назад »",
                "active": false
            }
        ],
        "path": "http://api.ord-a.ru/api/v2/creatives/5291/items",
        "per_page": 15,
        "to": 2,
        "total": 2
    }
}
3.7.2 Получение определенного медиафайла или текстового блока:  GET /creatives/{creative_id}/items/{id}
https://api.ord-a.ru/api/v2/creatives/{creative_id}/items/{id}
Данный метод используется для получения определенного медиафайла или текстового блока.
Параметры запроса:
Параметр Тип Обязательность Описание
creative_id число да идентификатор креатива
id число да идентификатор пункта креатива
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
403 Forbidden Ошибка
Пример запроса:
curl -X 'GET' \
  'https://api.ord-a.ru/api/v2/creatives/5291/items/707' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'X-CSRF-TOKEN: '
Пример ответа:
 {
    "data": {
        "id": 707,
        "external_id": null,
        "media": {
            "id": 6031,
            "name": "jpeg-home.jpg",
            "mime_type": "image/jpeg",
            "collection_name": "default",
            "url": "https://api.ord-a.ruu/storage/media/04-03-2024/cf4df75b-b0d2-419d-8a27-448a9a7071e8/jpeg-home.jpg",
            "disk": "media",
            "created_at": "2024-03-04T18:53:00.000000Z"
        },
        "text_data": null,
        "created_at": "2024-03-04T21:33:03+03:00"
    }
}
3.7.3  Добавление медиафайла или текстовых данных в модель:  POST /creatives/{creative_id}/items
ВНИМАНИЕ!

Если передать в ОДНОМ запросе "media" и "text_data", то "text_data" будет игнорироваться.
https://api.ord-a.ru/api/v2/creatives/{creative_id}/items
Данный метод используется для добавления медиафайла или текстовых данных в модель.
Параметры запроса:
Параметр Тип Обязательность Описание
creative_id число да идентификатор креатива
Код ответа Описание
201 Created Запрос выполнен
401 Unauthorized Доступ запрещен, невалидный токен
422 Unprocessable Content Ошибка во входных данных
Пример запроса при добавлении медиафайла по ссылке:
curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/creatives/5291/items' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "media": "https://www.aokmo.ru/upload/iblock/89c/ road_sign_361513_960_720.jpg",
 "description": null,
  "text_data": null,
  "external_id": null
}'
Пример ответа:
 {
    "data": {
        "id": 707,
        "external_id": null,
        "media": {
            "id": 6030,
            "name": "road_sign_361513_960_720.jpg",
            "mime_type": "image/jpeg",
            "collection_name": "default",
            "url": "https://api.ord-a.ru/storage/media/04-03-2024/2d58f4bd-d497-4b55-bec6-b9868743a69e/road_sign_361513_960_720.jpg",
            "disk": "media",
            "created_at": "2024-03-04T18:33:04.000000Z"
        },
        "text_data": null,
        "created_at": "2024-03-04T21:33:03+03:00"
    }
}
Пример запроса при добавлении медиа файла с типом данных multipart/form-data:
 curl --location 'https://api.ord-a.ru/api/v2/creatives/5291/items' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer  TOKEN' \
--form 'media=@"/D:/Work/ORD/pictures/0_7c779_5df17311_orig.jpg"'
Пример запроса при добавлении текстовых данных:
curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/creatives/5291/items' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "text_data": "тест"
}'
Пример ответа:
{
    "data": {
        "id": 708,
        "external_id": null,
        "media": null,
        "text_data": "тест",
        "created_at": "2024-03-04T21:46:15+03:00"
    }
}
3.7.4 Обновление (изменение сущности) загруженного медиафайла / текстового поля:  PUT /creatives/{creative_id}/items/{id}
https://api.ord-a.ru/api/v2/creatives/{creative_id}/items/{id}
Данный метод используется для обновления загруженного медиафайла / текстового поля.
Параметры запроса:
Параметр Тип Обязательность Описание
creative_id число да идентификатор креатива
id число да идентификатор пункта креатива (items)
Код ответа Описание
200 OK Запрос выполнен
401 Unauthorized Доступ запрещен, невалидный токен
403 Forbidden Ошибка
Пример запроса:
curl -X 'PUT' \
  'https://api.ord-a.ru/api/v2/creatives/5291/items/707' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "media": "https://jpeg.org/images/jpeg-home.jpg"
}'
Пример ответа:
 {
    "data": {
        "id": 707,
        "external_id": null,
        "media": {
            "id": 6031,
            "name": "jpeg-home.jpg",
            "mime_type": "image/jpeg",
            "collection_name": "default",
            "url": "https://api-dev.ord-a.ru/storage/media/04-03-2024/cf4df75b-b0d2-419d-8a27-448a9a7071e8/jpeg-home.jpg",
            "disk": "media",
            "created_at": "2024-03-04T18:53:00.000000Z"
        },
        "text_data": null,
        "created_at": "2024-03-04T21:33:03+03:00"
    }
}
3.7.5 Удаление загруженного медиафайла / текстового поля:  DELETE /creatives/{creative_id}/items/{id}
https://api.ord-a.ru/api/v2/creatives/{creative_id}/items/{id}
Данный метод используется для удаления загруженного медиафайла / текстового поля.
Параметры запроса:
Параметр Тип Обязательность Описание
creative_id число да идентификатор креатива
id число да идентификатор пункта креатива (items)
Код ответа Описание
200 OK Запрос выполнен
401 Unauthorized Доступ запрещен, невалидный токен
403 Forbidden Ошибка
Пример запроса:
curl -X 'DELETE' \
  'https://api.ord-a.ru/api/v2/creatives/5291/items/710' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d ' '
3.7.6 Массовое создание пунктов креативов:  POST /creatives/{creative_id}/items/insert
 https://api.ord-a.ru/api/v2/creatives/{creative_id}/items/insert
Данный метод используется для массового создания пунктов креативов. Для его использования необходимо сначала привязать медиа к пользователю, используя метод, описанный в 3.8.2 POST /user/media/
Параметры запроса:
Параметр Тип Обязательность Описание
creative_id число да идентификатор креатива
Код ответа Описание
204 OK Запрос выполнен
401 Unauthorized Доступ запрещен, невалидный токен
403 Forbidden Ошибка
Пример запроса:
curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/creatives/5465/items/insert' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "creative_items": [
    {
      "media_id": 6088
    },
    {
      "media_id": 6089
    }
  ]
}'
3.7.7 Атрибуты объекта «CreativeItems»:
Параметр Тип Обязательность Описание
creative_id число да идентификатор креатива, к которому крепится медиафайл / текстовые данные
id число да идентификатор загруженного объекта
media строка, file Условно обязательно

Обязательно, если не указано поле "text_data".

Примечание: если передать в одном запросе "media" и "text_data", то "text_data" будет игнорироваться
text_data строка (65000) Условно обязательно

Обязательно, если не указано поле "media".

Примечание: если передать в одном запросе "media" и "text_data", то "text_data" будет игнорироваться
description строка (1000) нет Описание изображения креатива
external_id строка (255) нет Учетный идентификатор в базе пользователя
media_id число да Идентификатор медиа, полученный при использовании пункта 3.8.2
3.8 Привязка медиафайлов к пользователю (UserMedia)
Данный метод необходим для использования массового создания пунктов в креативе через метод POST /creatives/{creative_id}/items/insert
3.8.1 Получение списка привязанных медиа к пользователю: GET /user/media
https://api.ord-a.ru/api/v2/user/media
Данный метод используется для получения списка привязанных медиа к пользователю.
Код ответа Описание
201 OK Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
Пример запроса:
curl -X 'GET' \
  'https://api.ord-a.ru/api/v2/user/media' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'X-CSRF-TOKEN: '
Пример ответа:
 {
    "data": [
        {
            "id": 5510,
            "name": "logo_ОРД-А(белый).png",
            "mime_type": "image/png",
            "collection_name": "temp",
            "url": null,
            "disk": "temporary",
            "created_at": "2023-12-26T09:20:26.000000Z"
        },
        {
            "id": 5511,
            "name": "logo_ОРД-А(белый).png",
            "mime_type": "image/png",
            "collection_name": "temp",
            "url": null,
            "disk": "temporary",
            "created_at": "2023-12-26T09:20:26.000000Z"
        },
        {
            "id": 5480,
            "name": "photo_2023-12-06_13-22-45.jpg",
            "mime_type": "image/jpeg",
            "collection_name": "temp",
            "url": null,
            "disk": "temporary",
            "created_at": "2023-12-25T10:49:25.000000Z"
        },
        {
            "id": 5481,
            "name": "screenshot-1 (1).png",
            "mime_type": "image/jpeg",
            "collection_name": "temp",
            "url": null,
            "disk": "temporary",
            "created_at": "2023-12-25T10:49:56.000000Z"
        },
        {
            "id": 5482,
            "name": "photo_2023-12-06_13-22-45.jpg",
            "mime_type": "image/jpeg",
            "collection_name": "temp",
            "url": null,
            "disk": "temporary",
            "created_at": "2023-12-25T10:51:31.000000Z"
        },
        {
            "id": 5512,
            "name": "photo_2023-12-06_13-22-45 (1).jpg",
            "mime_type": "image/jpeg",
            "collection_name": "temp",
            "url": null,
            "disk": "temporary",
            "created_at": "2023-12-26T09:20:26.000000Z"
        },
        {
            "id": 5483,
            "name": "screenshot-1 (1).png",
            "mime_type": "image/jpeg",
            "collection_name": "temp",
            "url": null,
            "disk": "temporary",
            "created_at": "2023-12-25T10:53:02.000000Z"
        },
        {
            "id": 5513,
            "name": "logo_ОРД-А(белый).png",
            "mime_type": "image/png",
            "collection_name": "temp",
            "url": null,
            "disk": "temporary",
            "created_at": "2023-12-26T09:20:26.000000Z"
        },
        {
            "id": 5484,
            "name": "screenshot-1 (1).png",
            "mime_type": "image/jpeg",
            "collection_name": "temp",
            "url": null,
            "disk": "temporary",
            "created_at": "2023-12-25T10:53:12.000000Z"
        },
        {
            "id": 5514,
            "name": "photo_2023-12-06_13-22-45 (1).jpg",
            "mime_type": "image/jpeg",
            "collection_name": "temp",
            "url": null,
            "disk": "temporary",
            "created_at": "2023-12-26T09:20:26.000000Z"
        },
        {
            "id": 5485,
            "name": "photo_2023-12-06_13-22-45.jpg",
            "mime_type": "image/jpeg",
            "collection_name": "temp",
            "url": null,
            "disk": "temporary",
            "created_at": "2023-12-25T10:54:59.000000Z"
        },
        {
            "id": 5515,
            "name": "photo_2023-12-06_13-22-45.jpg",
            "mime_type": "image/jpeg",
            "collection_name": "temp",
            "url": null,
            "disk": "temporary",
            "created_at": "2023-12-26T09:20:26.000000Z"
        },
        {
            "id": 5486,
            "name": "photo_2023-12-06_13-22-45.jpg",
            "mime_type": "image/jpeg",
            "collection_name": "temp",
            "url": null,
            "disk": "temporary",
            "created_at": "2023-12-25T10:55:03.000000Z"
        },
        {
            "id": 5487,
            "name": "photo_2023-12-06_13-22-45.jpg",
            "mime_type": "image/jpeg",
            "collection_name": "temp",
            "url": null,
            "disk": "temporary",
            "created_at": "2023-12-25T10:55:07.000000Z"
        },
        {
            "id": 5516,
            "name": "Снимок экрана 2023-10-26 в 13.16.32.png",
            "mime_type": "image/png",
            "collection_name": "temp",
            "url": null,
            "disk": "temporary",
            "created_at": "2023-12-26T09:38:51.000000Z"
        }
    ],
    "links": {
        "first": "http://api.ord-a.ru/api/v2/user/media?page=1",
        "last": "http://api.ord-a.ru/api/v2/user/media?page=6",
        "prev": null,
        "next": "http://api.ord-a.ru/api/v2/user/media?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 6,
        "links": [
            {
                "url": null,
                "label": "« Вперед",
                "active": false
            },
            {
                "url": "http://api.ord-a.ru/api/v2/user/media?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": "http://api.ord-a.ru/api/v2/user/media?page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "http://api.ord-a.ru/api/v2/user/media?page=3",
                "label": "3",
                "active": false
            },
            {
                "url": "http://api.ord-a.ru/api/v2/user/media?page=4",
                "label": "4",
                "active": false
            },
            {
                "url": "http://api.ord-a.ru/api/v2/user/media?page=5",
                "label": "5",
                "active": false
            },
            {
                "url": "http://api.ord-a.ru/api/v2/user/media?page=6",
                "label": "6",
                "active": false
            },
            {
                "url": "http://api.ord-a.ru/api/v2/user/media?page=2",
                "label": "Назад »",
                "active": false
            }
        ],
        "path": "http://api.ord-a.ru/api/v2/user/media",
        "per_page": 15,
        "to": 15,
        "total": 81
    }
}
3.8.2 Привязка медиа к пользователю: POST /user/media/
https://api.ord-a.ru/api/v2/user/media/
Данный метод используется для привязки медиа к пользователю.
Код ответа Описание
200 OK Статус успешного запроса
401 Unauthorized Ошибка во входных данных
Пример запроса при добавлении медиафайлов с типом данных multipart/form-data:
curl --location 'https://api.ord-a.ru/api/v2/user/media/' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer  TOKEN' \
--form 'media[]=@"/D:/Work/ORD/pictures/167686-dobro-oblako-atmosfera-gora-prirodnyj_landshaft-x750.jpg"' \
--form 'media[]=@"/D:/Work/ORD/pictures/166366-avtomobilnoe_osveshhenie-kommunikacionnoe_ustrojstvo-gadzhet-palec-pryamougolnik-x750.jpg"'
Пример ответа:
{
    "data": [
        {
            "id": 6044,
            "name": "167686-dobro-oblako-atmosfera-gora-prirodnyj_landshaft-x750.jpg",
            "mime_type": "image/jpeg",
            "collection_name": "temp",
            "url": null,
            "disk": "temporary",
            "created_at": "2024-03-07T07:33:28.000000Z"
        },
        {
            "id": 6045,
            "name": "166366-avtomobilnoe_osveshhenie-kommunikacionnoe_ustrojstvo-gadzhet-palec-pryamougolnik-x750.jpg",
            "mime_type": "image/jpeg",
            "collection_name": "temp",
            "url": null,
            "disk": "temporary",
            "created_at": "2024-03-07T07:33:28.000000Z"
        }
    ]
}
3.8.3 Удаление привязанного медиа к пользователю: DELETE /user/media/{id}
https://api.ord-a.ru/api/v2/user/media/{id}
Данный метод используется для удаления привязанного медиа к пользователю.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор креатива
Код ответа Описание
204 OK Запрос выполнен
401 Unauthorized Доступ запрещен, невалидный токен
404 Not Found Медиафайл не найден
Пример запроса:
curl -X 'DELETE' \
  'https://api.ord-a.ru/api/v2/user/media/5510' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d ' '
3.8.4 Атрибуты объекта «UserMedia» (UserMedia):
Параметр Тип Обязательность Описание
id число да идентификатор медиа
media[] array file да Массив медиа для загрузки
3.9 Акты (Invoices)
3.9.1  Получение  сведений об актах:  GET /invoices
 https://api.ord-a.ru/api/v2/invoices
Данный метод используется для получения списков актов.
Параметры запроса
Параметр Тип Обязательность Описание
page число нет Номер страницы
limit число нет Количество записей на странице
sort строка нет Используется при get запросе. Сортировка по столбцу. Допустимые значения: number, -number, date, -date, amount, -amount
Код ответа Описание
200 OK Положительный статус запроса
401 Unauthorized Доступ запрещен, невалидный токен
Пример запроса:
curl -X 'GET' \
  'https://api.ord-a.ru/api/v2/invoices' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'X-CSRF-TOKEN: '
Пример положительного ответа:
 {
    "data": [
        {
            "id": 2771,
            "number": "rd",
            "is_partner": false,
            "membership_id": 1,
            "contract_id": 32209,
            "subject": null,
            "date": "2023-12-11",
            "start_date": "2023-12-11",
            "end_date": "2023-12-18",
            "is_vat": true,
            "amount": 0,
            "invoice_items_sum_amount": "0",
            "client_role": "rd",
            "contractor_role": "ra",
            "external_id": null,
            "created_at": "2024-02-28T11:15:05+03:00",
            "deleted_at": null
        },
        {
            "id": 2770,
            "number": "rd",
            "is_partner": false,
            "membership_id": 1,
            "contract_id": 32209,
            "subject": null,
            "date": "2023-12-11",
            "start_date": "2023-12-11",
            "end_date": "2023-12-18",
            "is_vat": true,
            "amount": 0,
            "invoice_items_sum_amount": "0",
            "client_role": "rd",
            "contractor_role": "ra",
            "external_id": null,
            "created_at": "2024-02-28T11:15:04+03:00",
            "deleted_at": null
        }
  ],
  "links": {
    "first": "https://api.ord-a.ru/api/v2/invoices?page=1",
    "last": "https://api.ord-a.ru/api/v2/invoices?page=2",
    "prev": null,
    "next": "https://api.ord-a.ru/api/v2/invoices?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Вперед",
        "active": false
      },
      {
        "url": "https://api.ord-a.ru/api/v2/invoices?page=1",
        "label": "1",
        "active": true
      }
    ],
    "path": "https://api.ord-a.ru/api/v2/invoices",
    "per_page": 2,
    "to": 2,
    "total": 2
  }
}
3.9.2  Получение  определенного акта:  GET /invoices/{id}
https://api.ord-a.ru/api/v2/invoices/{id}
Данный метод используется для получения списков актов.
Параметры запроса
Параметр Тип Обязательность Описание
id число нет идентификатор акта
Код ответа Описание
200 OK Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Идентификатор акта не найден
Пример запроса:
curl -X 'GET' \
  'https://api.ord-a.ru/api/v2/invoices/2771' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'X-CSRF-TOKEN: '
Успешный ответ:
 {
    "data": {
        "id": 2771,
        "number": "rd",
        "is_partner": false,
        "membership_id": 1,
        "erir_entity": {
            "id": 44386,
            "message": null,
            "status": "В очереди на отправку",
            "status_label": "pending",
            "payload": {
                "id": 2771,
                "date": "2023-12-11",
                "isVat": true,
                "items": [
                    {
                        "isVat": true,
                        "amount": 0,
                        "contractId": 32209
                    }
                ],
                "amount": 0,
                "number": "rd",
                "report": {
                    "reporterId": 12937,
                    "createdDatetimeInOrd": "2024-02-28 22:15:05.000000",
                    "updatedDatetimeInOrd": "2024-02-28 22:40:34.000000"
                },
                "endDate": "2023-12-18",
                "startDate": "2023-12-11",
                "clientRole": "rd",
                "contractId": 32209,
                "violations": [],
                "contractorRole": "ra"
            },
            "created_at": "2024-02-28T11:15:05+03:00",
            "pending_at": "2024-02-28T11:20:05+03:00"
        },
        "contract_id": 32209,
        "subject": null,
        "date": "2023-12-11",
        "start_date": "2023-12-11",
        "end_date": "2023-12-18",
        "contract": {
            "id": 32209,
            "number": "ДС2",
            "is_partner": false,
            "membership_id": 1,
            "type": "additional-agreement",
            "client_id": 14167,
            "contractor_id": 14163,
            "is_reg_report": false,
            "date": "2024-02-28",
            "amount": null,
            "is_vat": false,
            "action_description": null,
            "action": null,
            "subject": "org-distribution",
            "subject_description": null,
            "parent_contract_id": 32208,
            "agent_acting_for_publisher": false,
            "external_id": null,
            "created_at": "2024-02-28T11:27:30+03:00",
            "deleted_at": null
        },
        "is_vat": true,
        "amount": 0,
        "invoice_items_sum_amount": null,
        "client_role": "rd",
        "contractor_role": "ra",
        "external_id": null,
        "created_at": "2024-02-28T11:15:05+03:00",
        "deleted_at": null
    }
}
3.9.3  Добавление акта:  POST /invoices
https://api.ord-a.ru/api/v2/invoices
Данный метод используется для создания акта.
Код ответа Описание
201 Created Акт создан
401 Unauthorized Доступ запрещен, невалидный токен
422 Unprocessable Content Некорректный запрос
Пример запроса:
 curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/invoices' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "date": "2024-02-25",
  "start_date": "2024-02-20",
  "end_date": "2024-02-25",
  "amount": 1000,
  "is_vat": true,
  "number": "string",
  "contract_id": 32206,
  "client_role": "rd",
  "contractor_role": "ra",
  "external_id": "123"
}'
Успешный ответ:
 {
    "data": {
        "id": 2772,
        "number": "string",
        "is_partner": false,
        "membership_id": 1,
        "contract_id": 32206,
        "subject": null,
        "date": "2024-02-25",
        "start_date": "2024-02-20",
        "end_date": "2024-02-25",
        "is_vat": true,
        "amount": 1000,
        "invoice_items_sum_amount": null,
        "client_role": "rd",
        "contractor_role": "ra",
        "external_id": "123",
        "created_at": "2024-02-28T13:36:16+03:00",
        "deleted_at": null
    }
}
3.9.4  Обновление акта:  PUT /invoices/{id}
https://api.ord-a.ru/api/v2/invoices/{id}
Данный метод используется для получения списков актов.
Параметры запроса
Параметр Тип Обязательность Описание
id число да идентификатор акта
Код ответа Описание
200 OK Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Идентификатор акта не найден
422 Unprocessable Content Некорректный запрос
Пример запроса:
curl -X 'PUT' \
  'https://api.ord-a.ru/api/v2/invoices/2772' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "date": "2024-02-25",
  "start_date": "2024-02-20",
  "end_date": "2024-02-25",
  "amount": 2000,
  "is_vat": true,
  "number": "Измененный",
  "contract_id": 32206,
  "client_role": "rd",
  "contractor_role": "ra",
  "external_id": "123"
}'
Успешный ответ:
{
    "data": {
        "id": 2772,
        "number": "Измененный",
        "is_partner": false,
        "membership_id": 1,
        "erir_entity": {
            "id": 44427,
            "message": null,
            "status": "В очереди на отправку",
            "status_label": "pending",
            "payload": {
                "id": 2772,
                "contractId": 32206,
                "clientRole": "rd",
                "contractorRole": "ra",
                "date": "2024-02-25",
                "startDate": "2024-02-20",
                "endDate": "2024-02-25",
                "amount": 2000,
                "isVat": true,
                "number": "Измененный",
                "items": null,
                "violations": [],
                "report": {
                    "reporterId": 12937,
                    "createdDatetimeInOrd": "2024-02-29 00:36:16.000000",
                    "updatedDatetimeInOrd": "2024-02-29 00:37:22.000000"
                }
            },
            "created_at": "2024-02-28T13:36:16+03:00",
            "pending_at": "2024-02-28T13:41:16+03:00"
        },
        "contract_id": 32206,
        "subject": null,
        "date": "2024-02-25",
        "start_date": "2024-02-20",
        "end_date": "2024-02-25",
        "is_vat": true,
        "amount": 2000,
        "invoice_items_sum_amount": null,
        "client_role": "rd",
        "contractor_role": "ra",
        "external_id": "123",
        "created_at": "2024-02-28T13:36:16+03:00",
        "deleted_at": null
    }
}
3.9.5  Массово добавить/обновить данные актов:  POST /invoices/upsert
 https://api.ord-a.ru/api/v2/invoices/upsert
Данный метод используется для получения списков актов.
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
422 Unprocessable Content Некорректный запрос
Пример запроса:
 curl -X 'POST' \
  ' https://api.ord-a.ru/api/v2/invoices/upsert' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "invoices": [
    {
      "id": 7341,
      "date": "2024-02-25",
      "start_date": "2024-02-20",
      "end_date": "2024-02-25",
      "amount": 2000,
      "is_vat": true,
      "number": "Акт 1",
      "contract_id": 32834,
      "client_role": "ra",
      "contractor_role": "ra",
      "external_id": "123"
    },
    {
      "id": 7328,
      "date": "2024-02-25", 
      "start_date": "2024-02-20",
      "end_date": "2024-02-25",
      "amount": 0,
      "is_vat": true,
      "number": "Акт 2",
      "contract_id": 32820,
      "client_role": "rd",
      "contractor_role": "ra",
      "external_id": "12"
    }
  ]
}'
Успешный ответ:
 {
    "data": [
        {
            "id": 7341,
            "external_id": "123"
        },
        {
            "id": 7328,
            "external_id": "12"
        }
    ],
    "message": "OK"
}
3.9.6 Удаление акта:  DELETE /invoices/{id}?relations=true
https://api.ord-a.ru/api/v2/invoices/{id}relations=true
Данный метод используется для удаления акта. Внимание! Связанные сущности также удаляются (invoice_items и statistics)
Код ответа Описание
204 ОК Запрос прошел успешно
404 Not found Объект не найден
401 Unauthorized Доступ запрещен
Пример запроса:
 curl -X 'DELETE' \
  'https://api.ord-a.ru/api/v2/invoices/2579?relations=true' \
  -H 'accept: application/json' \
  -H 'Authorization:   Bearer  TOKEN' \
  -H 'X-CSRF-TOKEN: '
3.9.7 Атрибуты объекта «Акты» (Invoices):
Параметр Тип Обязательность Описание
contract _id число Условно обязательно

Идентификатор договора (отсылка к ранее зарегистрированному договору/доп.соглашению)

Если client_role='rd', то invoice.contract_id = invoice_items.contract_id ИЛИ invoice.contract_id - это доп. соглашение к invoice_items.contract_id
date дата (date) да Дата акта в формате ГГГГ-мм-дд
  1. Дата должна быть не ниже, чем 01.01.1991
  2. Дата должна быть меньше или равна текущей дате
start_date дата (date) да Дата начала периода в формате ГГГГ-мм-дд
  1. Дата должна быть не ниже, чем 01.01.1991
  2. Дата должна быть меньше или равна даты окончания периода акта
  3. Дата должна быть меньше или равна текущей дате
end_date дата (date) да Дата окончания периода в формате ГГГГ-мм-дд
  1. Дата должна быть не ниже, чем 01.01.1991
  2. Дата должна быть больше или равна дате начала периода акта
  3. Дата должна быть меньше или равна текущей дате 2100-12-31
amount число да

Сумма акта. Разрешено значение 0

Формат: два знака после запятой, разделитель - точка 22.23

Ограничить сумму, передаваемую в акте: максимальное число, которое может быть передано 10 000 000 000 руб.

Сумма акта должна быть больше или равна сумме всех сумм в пунктах разаллокации по изначальному договору.
is_vat булево да Признак "с НДС"
(Возможные значения: true/false)
number строка (255) нет Номер акта
subject строка (255) нет Описание предмета акта
page число нет Номер страницы
limit число нет Количество записей на странице
sort строка нет Используется при get запросе. Сортировка по стоблцу. Допустимые значения: number, -number, date, -date, amount_fact, -amount_fact
external_id строка (255) нет Учетный идентификатор в базе пользователя
client_role строка (20) да

Роль заказчика в акте:

rr - Рекламораспространитель
ors - Оператор рекламной системы
rd - Рекламодатель
ra - Рекламное агентство

В случае обычного договора и посреднического договора:
- Если роль заказчика РД, то роль исполнителя может быть РА, ОРС, РР.
- Если роль заказчика РА, то роль исполнителя может быть РА, ОРС, РР.
- Если роль заказчика ОРС, то роль исполнителя может быть ОРС, РР.
- Заказчик не может быть в роли РР.

В случае посреднического договора, когда агент предоставляет сторону принципала (agent_acting_for_publisher=true):
Если роль заказчика РР, то роль исполнителя может быть РА или ОРС.

contractor _role строка (20) да

Роль исполнителя в акте:

rr - Рекламораспространитель
ors - Оператор рекламной системы
ra - Рекламное агентство
Исполнитель не может быть в роли РД
include Строка нет Параметр для получения статусов сущностей для GET запроса, значение – erirEntity пример использования (https://api.ord-a.ru/api/v2/ invoices?include=erirEntity)
В json ответе от сервера появятся данные (
...
"erir_entity":
{
"message": "",
"status": "В очереди на отправку"
},
...
)
filter [option] строка нет Параметр для поиска записей сущностей для GET запроса, допустимые значения:
- id;
- number;
- number-exact;
- period;
- date;
- amount;
- contract.amount;
- contract_id;
- external_id,
- status (1, 2, 3, 4, 6, 10)

Пример запроса: https://api.ord-a.ru/api/v2/invoices /?include=erirEntity&limit=10&page=1&filter[id]=4

Пример запроса по фильтру period: https://api.ord-a.ru/api/v2/invoices?filter[period]=20.07.2023-20.07.2023
3.10   Детализация акта по атрибутам изначального договора (InvoiceItems)
3.10.1  Получение сведений о детализаций актов по атрибутам изначального договора:  GET /invoices/items
https://api.ord-a.ru/api/v2/invoices/items
Данный метод используется для получения детализации акта по атрибутам изначального договора.
Параметры запроса:
Параметр Тип Обязательность Описание
page число нет Номер страницы
limit число нет Количество записей на странице
sort строка нет Используется при get запросе. Сортировка по столбцу. Допустимые значения: amount, -amount
Код ответа Описание
200 ОК Положительный статус запроса
401 Unauthorized Доступ запрещен, невалидный токен
Пример запроса:
curl -X 'GET' \
  'https://api.ord-a.ru/api/v2/invoices/items' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'X-CSRF-TOKEN: '
Успешный ответ:
 {
  "data": [
    {
            "id": 1585,
            "is_partner": false,
            "membership_id": 1,
            "invoice_id": 2771,
            "invoice": {
                "id": 2771,
                "number": "rd"
            },
            "contract_id": 32209,
            "amount": 0,
            "is_vat": true,
            "contract": {
                "id": 32209,
                "number": "ДС2"
            },
            "external_id": null,
            "deleted_at": null,
            "creatives": [
                5140
            ]
        },
        {
            "id": 1584,
            "is_partner": false,
            "membership_id": 1,
            "invoice_id": 2770,
            "invoice": {
                "id": 2770,
                "number": "rd"
            },
            "contract_id": 32208,
            "amount": 0,
            "is_vat": true,
            "contract": {
                "id": 32208,
                "number": "ДС1"
            },
            "external_id": null,
            "deleted_at": null,
            "creatives": []
        }
  ],
  "links": {
    "first": "https://api.ord-a.ru/api/v2/invoices/items?page=1",
    "last": "https://api.ord-a.ru/api/v2/invoices/items?page=2",
    "prev": null,
    "next": "https://api.ord-a.ru/api/v2/invoices/items?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 2,
    "links": [
      {
        "url": null,
        "label": "« Вперед",
        "active": false
      },
      {
        "url": "https://api.ord-a.ru/api/v2/invoices/items?page=1",
        "label": "1",
        "active": true
      }
    ],
    "path": "https://api.ord-a.ru/api/v2/invoices/items",
    "per_page": 2,
    "to": 2,
    "total": 2
  }
}
3.10.2  Получение сведений определенной детализации акта по атрибутам изначального договора:  GET /invoices/items/{id}
 https://api.ord-a.ru/api/v2/invoices/items/{id}
Данный метод используется для получения определенной детализации акта по атрибутам изначального договора.
Параметры запроса:
Параметр Тип Обязательность Описание
id число нет идентификатор пункта акта
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Идентификатор пункта акта не найден
Пример запроса:
curl -X 'GET' \
  'https://api.ord-a.ru/api/v2/invoices/items/1585' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'X-CSRF-TOKEN: '
Успешный ответ:
 {
    "data": {
        "id": 1585,
        "is_partner": false,
        "membership_id": 1,
        "erir_entity": {
            "id": null,
            "message": null,
            "status": "В очереди на отправку",
            "status_label": "pending",
            "payload": null,
            "created_at": null,
            "pending_at": null
        },
        "invoice_id": 2771,
        "contract_id": 32209,
        "amount": 0,
        "is_vat": true,
        "contract": {
            "id": 32209,
            "number": "ДС2"
        },
        "external_id": null,
        "deleted_at": null
    }
}
3.10.3 Создание детализации акта по атрибутам изначального договора:  POST /invoices/items/
https://api.ord-a.ru/api/v2/invoices/items/
Данный метод используется для создания определенной детализации акта по атрибутам изначального договора.
Код ответа Описание
201 Created Пункт акта создан
401 Unauthorized Доступ запрещен, невалидный токен
422 Unprocessable Content Некорректный запрос
Пример запроса:
curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/invoices/items' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "invoice_id": 2769,
  "contract_id": 32209,
  "amount": 0,
  "is_vat": true,
  "external_id": "4"
}'
Успешный ответ:
{
    "data": {
        "id": 1591,
        "is_partner": false,
        "membership_id": 1,
        "invoice_id": 2769,
        "invoice": {
            "id": 2769,
            "number": "rd"
        },
        "contract_id": 32209,
        "amount": 0,
        "is_vat": true,
        "contract": {
            "id": 32209,
            "number": "ДС2"
        },
        "external_id": "4",
        "deleted_at": null
    }
}
3.10.4 Обновление детализации акта по атрибутам изначального договора:  PUT /invoices/items/{id}
https://api.ord-a.ru/api/v2/invoices/items/{id}
Данный метод используется для обновления определенной детализации акта по атрибутам изначального договора.
Параметры:
Параметр Тип Обязательность Описание
id число да идентификатор пункта акта
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Идентификатор пункта акта не найден
422 Unprocessable Content Некорректный запрос
Пример запроса:
curl -X 'PUT' \
  ' https://api.ord-a.ru/api/v2/invoices/items/1591' \
  -H 'accept: application/json' \
  -H 'Authorization:  Bearer  TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "invoice_id": 2772,
  "contract_id": 32206,
  "amount": 2000,
  "is_vat": true,
  "external_id": "4"
}'
Успешный ответ:
 {
    "data": {
        "id": 1591,
        "is_partner": false,
        "membership_id": 1,
        "invoice_id": 2772,
        "invoice": {
            "id": 2772,
            "number": "rd"
        },
        "contract_id": 32206,
        "amount": 0,
        "is_vat": false,
        "contract": {
            "id": 32206,
            "number": "ДС2"
        },
        "external_id": "4",
        "deleted_at": null
    }
}
3.10.5  Удаление детализации акта по атрибутам изначального договора:  DELETE /invoices/items/{id}
https://api.ord-a.ru/api/v2/invoices/items/{id}
Данный метод используется для удаления определенной детализации акта по атрибутам изначального договора.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор пункта акта
Код ответа Описание
204 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Идентификатор организации не найден
Пример запроса:
curl -X 'DELETE' \
  'https://api.ord-a.ru/api/v2/invoices/items/1' \
  -H 'accept: application/json' \
  -H 'Authorization:   Bearer  TOKEN' \
  -H 'X-CSRF-TOKEN: '
3.10.6  Восстановление детализации акта по атрибутам изначального договора:  GET /invoices/items/{id}/restore
 https://api.ord-a.ru/api/v2/invoices/items/{id}/restore
Данный метод используется для восстановления определенной детализации акта по атрибутам изначального договора.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор пункта акта
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Идентификатор пункта акта не найден
Пример запроса:
curl -X 'GET' \
  'https://api.ord-a.ru/api/v2/invoices/items/1/restore' \
  -H 'accept: application/json' \
  -H 'Authorization:  Bearer  TOKEN' \
  -H 'X-CSRF-TOKEN: '
3.10.7 Массовое добавление/обновление детализаций актов по атрибутам изначального договора:  POST /invoices/items/upsert
https://api.ord-a.ru/api/v2/invoices/items/upsert
Данный метод используется для массового добавления, обновления данных актов по атрибутам изначального договора.
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
422 Unprocessable Content Некорректный запрос
Пример запроса:
curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/invoices/items/upsert' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "invoice_items": [
    {
      "invoice_id": 7344,
      "contract_id": 32834,
      "amount": 0,
      "is_vat": true,
      "external_id": "8"
    }
  ]
}'
Успешный ответ:
{
    "data": [
        {
            "id": 25771,
            "external_id": "8"
        }
    ],
    "message": "OK"
}
3.10.8 Атрибуты объекта «Детализация акта по атрибутам изначального договора» (Invoices/items):
Параметр Тип Обязательность Описание
contract_id число да Идентификатор договора (отсылка к ранее зарегистрированному договору/доп.соглашению)
amount число да

Сумма в привязке к изначальному договору

Формат: два знака после запятой, разделитель - точка 22.23
12 цифр до точки, т.е. максимальное число, которое может быть передано = 999 999 999 999
is_vat булево да Признак "с НДС"
(Возможные значения: true/false)
invoice_id число да id акта
external_id строка(255) нет Учетный идентификатор в базе пользователя
include Строка нет Параметр для получения статусов сущностей для GET запроса, значение – lastEntity пример использования (https://api.ord-a.ru/api/v2/invoices/items?include=lastEntity)
В json ответе от сервера появятся данные (
...
"erir_entity":
{
"message": "",
"status": "В очереди на отправку"
},
...
)
sort строка нет Параметр для сортировки массива сущностей для GET запроса, допустимые значения - amount.
Пример запроса - https://api.ord-a.ru/api/v1 /invoices/items?sort=name
filter[option] строка нет Параметр для поиска записей сущностей для GET запроса, допустимые значения - invoice_id.
Пример запроса - https://api.ord-a.ru/api/v2/invoices/items /?filter[invoice_id]=4
Смотреть далееВернуться в начало
Оглавление
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)