Тип/свойство | Описание |
---|---|
Organizations | |
name | Обновлены паттерны Паттерн для fl (ФЛ): ADVERTISER_FL_NAME_PATTERN = "^[А-яёЁIVXLCDM]+([- ']?[А-яёЁIVXLCDM]+)*$"; Паттерн для ip (ИП): ADVERTISER_IP_NAME_PATTERN_1 = "(^[А-яёЁIVXLCDM—–\\-'\\.]+[А-яёЁIVXLCDM—–\\-'\\. ]*[А-яёЁIVXLCDM—–\\-'\\.]+$)"; ADVERTISER_IP_NAME_PATTERN_2 = "(^.*[А-яё]+.*$)"; Если не проходит либо ADVERTISER_IP_NAME_PATTERN_1, либо ADVERTISER_IP_NAME_PATTERN_2, то ошибка. Паттерн для ul (ЮЛ): |
Creatives | |
kktu | Добавлено поле ККТУ - классификатор категорий товаров и услуг:
|
GET /kktu | Добавлен метод для получения списка ККТУ |
CreativeItems | |
description | Для методов /creatives/{creative_id}/items/{id} и /creatives/{creative_id}/items/insert поле «description» (Описание изображения креатива) стало необязательным, однако, если не заполнено, подтягивается автоматически из поля «description» (Описание объекта рекламирования) соответствующего креатива. |
Statistics | |
Введена проверка составного ключа на уникальность: [creative_id, platform_id, monthYear(date_start_fact), type] – при отсутствии связи с актом; [invoice_item_id, creative_id, platform_id, monthYear(date_start_fact), type] – при наличии связи с актом. |
Тип/свойство | Описание |
---|---|
Organizations | |
legal_address, post_address | Из запросов убраны поля: "legal_address": { "city": null, "street": null, "building": null, "postcode": null }, "post_address": { "city": null, "street": null, "building": null, "postcode": null } |
Сontracts | |
is_vat | Убрано поле "is_vat" (НДС). |
expiration_date | Добавлено необязательное поле "expiration_date" (дата окончания действия договора). |
parent_contract_id | Для договора с type = "additional-agreement" нельзя указать в parent_contract_id договор с type = "additional-agreement" (запрет на добавление дополнительного соглашения к дополнительному соглашению). |
amount |
Дополнительная валидация для поля "amount":
|
action_description | Убрано поле "action_description" (Описание) |
subject_description | Убрано поле "subject_description" (Описание) |
subject | Для поля "subject" добавится параметр "representation" - Представительство |
Creatives | |
is_political | Убрано поле "is_political" (Политическая реклама) |
target_audience | Убрано поле "target_audience" (Параметры целевой аудиотории рекламы) |
okved | Убрано поле "okved" (ОКВЭД) |
type |
Изменены возможные значения для поля "type" (тип распространения рекламы). Убран тип "other" – Иное Возможные значения:
|
is_media | Убрано поле "is_media" |
name | Убрано поле "name" |
CreativeItems | |
text_data |
Текстовые данные креатива необходимо указывать, если в поле "type" (тип распространения рекламы) указано одно из следующих значений:
|
media |
В креатив необходимо добавить медиа, если в поле "type" (тип распространения рекламы) указано одно из следующих значений:
|
description |
Обязательно для заполнения, если передается "media" в формате "Изображение". Возможные расширения для формата “Изображение:
|
Statistics | |
is_vat | Убрано поле "is_vat" (НДС). |
type | Поле "type" (Тип РК) стало обязательным |
amount | Максимальное число в поле "amount" (Стоимость оказанных услуг) увеличилось до 10 000 000 000.00000. |
amount_per_show | Максимальное число в поле "amount_per_show" (Стоимость единицы оказания услуг) увеличилось до 10 000 000 000.00000. |
Invoices | |
subject | Убрано поле "subject" (описание предмета акта) |
amount |
Для поля "amount" введена следующая проверка: сумма в актах должна быть больше нуля, исключение, если акт относится к безвозмездным договорам, когда в договоре явным образом указана стоимость договора равная 0. Ошибка выдается в следующих случаях:
|
contractor_role | Дополнительная валидация для ролей в акте: если указывается договор, в котором agent_acting_for_publisher = true, то в акте не может быть указан исполнитель ("contractor_role") в роли Рекламораспространителя ("rr"). |
InvoiceItems | |
is_vat | Убрано поле "is_vat" (НДС). |
Тип/свойство | Описание |
---|---|
Platforms | |
type | Убран тип "is" - информационная система |
Statistics | |
type | Добавлен параметр "type" - "Тип рекламной кампании". Возможные значения: • other - Иное; • cpm - CPM; • cpc - CPC; • cpa - CPA. Внимание! Поле станет обязательным с 01.10.24. |
date_end_fact, date_start_fact | Если date_end_fact > 31.04.2024 и invoice_item_id заполнено (есть связь с пунктом акта), то date_end_fact и date_start_fact должны быть в рамках одного месяца |
date_end_plan, date_start_plan | Если date_end_plan > 31.04.2024 и invoice_item_id заполнено (есть связь с пунктом акта), то date_end_fact и date_start_plan должны быть в рамках одного месяца |
POST /statistics/bulk/delete | Добавлен метод массового удаления статистики |
Invoices | |
unset_statistics | Для метода DELETE /invoices/{id} добавлен параметр unset_statistics, отвечающий за отвязывание (unset_statistics=true) или удаление статистики (unset_statistics=false) |
Invoice_items | |
unset_statistics | Для метода DELETE /invoices/items/{id} добавится параметр unset_statistics, отвечающий за отвязывание (unset_statistics=true) или удаление статистики (unset_statistics=false) |
Тип/свойство | Описание |
---|---|
Organizations | |
platforms | Поле стало не обязательным |
name | Добавлен паттерн в зависимости от значения в поле type. Паттерн для ip: ADVERTISER_FL_IP_NAME_PATTERN = "^[А-яёЁIVXLCDM']+([- ]?[А-яёЁIVXLCDM']+)*$"; Паттерн для fl: name != null && !ValidationUtils.validateAdvertiserName( name, AdvertiserAndPlatformValidationPatterns .ADVERTISER_FL_IP_NAME_PATTERN) && !ValidationUtils.validateAdvertiserName( name, AdvertiserAndPlatformValidationPatterns .ADVERTISER_NAME_PATTERN_SPECS) где, ADVERTISER_FL_IP_NAME_PATTERN = "^[А-яёЁIVXLCDM']+([- ]?[А-яёЁIVXLCDM']+)*$"; ADVERTISER_NAME_PATTERN_SPECS = "^(?![—–-])(?!.*[-—–]$)(?!.*[-—–]{2})(?!.* ).*$" Паттерн для ul: ADVERTISER_UL_NAME_PATTERN = "^ (?!\\s*[^а-яёА-ЯЁ0-9A-Za-z]+$)[а-яёА-ЯЁ0-9A-Za-z \\-\\–\\—\\&\\#\\,\\.\\;\\!\\?\\‘\\\\'\\+\\*\\№\\/\\:\\|\\_\\%\\°\\«\\»\\ \\(\\)\\\"\\n]+"; Паттерн для ffl и ful: ADVERTISER _FFL_FUL_NAME_PATTERN = "^ (?!\\s*[^a-zA-Zа-яА-Я0-9]+$)[a-zA-Zа-яёА-ЯЁ0-9 \\-\\–\\—\\&\\#\\,\\.\\;\\!\\?\\‘\\\\'\\+\\*\\№\\/\\:\\|\\_\\%\\°\\«\\»\\ \\(\\)\\\"\\n]+"; |
Platforms, Organizations, Сontracts, Creatives, Statistics, Invoices | |
GET по id, include=erirEntity | Изменено содержание параметра "erir_entity": добавлена дополнительная информация об отправке в ЕРИР. В erir_entity.status выводится статус первичной успешной отправки в ЕРИР, если такая имеется. В "erir_entity.last_item.status" содержится информация о текущем статусе отправки в ЕРИР. Пример: "erir_entity": { "id": 237, "status": "Зарегистрирован", "status_label": "registered", "registered_at": "2024-05-15T18:34:05+03:00" "last_item": { "id": 265, "status": "Зарегистрирован", "status_label": "registered", }, "errors": [], "message": null, "pending_at":"2024-05-16T19:40:05+03:00" "status_changed_at": "2024-05-16T21:40:05+03:00", }, } |
Тип/свойство | Описание |
---|---|
Platforms, Organizations, Сontracts, Creative | |
dependent_relationships | В ответах GET запросов по id и DELETE выводится параметр, показывающий связанные (дочерние) объекты. Пример ответа для DELETE: { "message": "У данного объекта есть зависящие сущности", "dependent_relationships": [ { "name": "creative", "id": 5574 }, { "name": "creative", "id": 5579 } ] } |
Organizations, Contracts, Invoices, Invoices/items | |
sort | Добавлена сортировка по id и -id |
Тип/свойство | Описание |
---|---|
Creatives | |
co_branding | Признак совместных кампаний (кобрендинг). Данный параметр является необязательным. Если не передавать, по умолчанию проставляется как false. Выводится во всех методах /creatives |
contract_id | Принимается массив id договоров для co_branding = true. Указывается как минимум два contract_id |
Сontracts | |
type | Добавлен новый тип договоров "external" (внешний договор). Применяется в случае необходимости добавления договоров из ЕРИР в CID |
cid | Указывается, если type=external. Передается CID внешнего договора. Выводится в GET запросах. |
Тип/свойство | Описание |
---|---|
Creatives | |
okveds | Расширен паттерн для ОКВЭД (длина значения ОКВЭД может составлять от 3 до 6 символов)
Напоминание: ОКВЭД более не обязателен. Если не указывается, в ЕРИР отправляется 00.00 (проставляется нами автоматом) |
is_media | Данный параметр был удален |
Тип/свойство | Описание |
---|---|
Platforms | |
owner_organization_id | Необязательное поле, в котором указывается id организации-владельца площадки |
url | Проверка на протоколы http:// и https:// |
name | Ограничено до 100 символов |
Organizations | |
owned_platforms | Необязательное поле. Передается массив id площадок, для которых данный контрагент является владельцем. |
Сontracts | |
number | Расширено до 255 символов |
type=additional-agreement | При создании доп. соглашения (additional-agreement) запрещается привязывать родительский договор (parent_сontract_id), в котором client_id (Идентификатор контрагент - заказчик) и contractor_id (Идентификатор контрагент-исполнителя) отличается от client_id и contractor_id создаваемого доп. соглашения |
Invoices | |
contractor_role | Запрещено передавать rd (исполнитель не может быть рекламодателем) |
end_date | Дата окончания по акту может быть до 2100-12-31 |
contract_id | Если client_role='rd', то идентификатор договора акта должен быть равен идентификатору изначального договора, либо являться дополнительным соглашением к изначальному договору (invoice.contract_id = invoice_items.contract_id ИЛИ invoice.contract_id - это доп. соглашение к invoice_items.contract_id) |
client_role, contractor_role | Добавлено возможное сочетание ролей: client_role=rr, contractor_role=ors, если в contract_id указан договор с типом "intermediary-contract" со значением agentActingForPublisher= "true" |
Statistics | |
date_end_fact, date_start_fact | Если date_end_fact > 30.09.2023 и invoice_item_id заполнено (есть связь с пунктом акта), то date_end_fact и date_start_fact должны быть в рамках одного месяца |
date_end_fact, date_start_fact | Если invoice_item_id = null, то date_end_fact и date_start_fact должны быть в рамках одного месяца |
date_end_plan, date_start_plan | Если date_end_plan > 30.09.2023 и invoice_item_id заполнено (есть связь с пунктом акта), то date_end_ plan и date_start_ plan должны быть в рамках одного месяца |
date_end_plan, date_start_plan | Если invoice_item_id = null, то date_end_plan и date_start_ plan должны быть в рамках одного месяца |
date_start_fact | Если invoice_item_id заполнено, то date_start_fact должно быть позже либо равно start_date в invoices |
Тип/свойство | Описание |
---|---|
Creatives, Invoices | |
status | Новый статус отправки "status": "Ожидание данных". Выводится для объектов creatives без медиа или текстовых данных и invoices без invoice_items.
Внимание! Не выводится для объектов, созданных до данного релиза. Примечание: Объекты с таким статусом не будут отправлены в ЕРИР без соответствующих данных. |
Creatives | |
filter[statistics] | Фильтр по поиску креативов со статистикой filter[statistics]=with и без статистики filter[statistics]=without |
Creatives, Invoices | |
filter[status]=6 | Фильтр по поиску статуса «Ожидание данных» |
Тип/свойство | Описание |
---|---|
Invoices | |
DELETE /invoices/{id}?relations=true | Метод удаления акта. Внимание! Удаляются также связанные сущности (invoice_items и statistics) |
Statistics | |
amount | Валидация: если amount_per_show = 0, то amount не может быть больше 0 |
Тип/свойство | Описание |
---|---|
Platforms, Organizations, Сontracts, Creatives, Statistics, Invoices | |
include=erirEntity | Фильтр для получения статусов об отправки данных в ЕРИР изменен с include=lastErirStat на include=erirEntity |
Platforms, Organizations, Сontracts, Creatives, Statistics, Invoices | |
erir_entity | В get запросах при использовании фильтра include=lastErirStat название поля "erir_stat" меняется на "erir_entity" |
Platforms, Organizations, Сontracts, Creatives, Statistics, Invoices | |
erir_entity | В get запросах по id объекта (например, GET /platforms/{id} ) в теле объекта возвращается статус отправки в ЕРИР в виде
{ … "erir_entity": { "message": null, "status": "Зарегистрирован" }, … } |
Тип/свойство | Описание |
---|---|
Сontracts | |
date | Дата договора. Изменен тип данных с timestamp на date (Было “2023-09-14T17:47:46.000000Z”, стало “2023-09-14”. Старый формат также принимается, однако на нашей стороне преобразуется в date) |
created_at | Дата создания. Формат дат изменен с «2023-09-14T17:47:46.000000Z» на «2023-09-26T09:44:22+03:00» |
invoices | |
date | Дата акта. Изменен тип данных с timestamp на date (Было “2023-09-14T17:47:46.000000Z”, стало “2023-09-14”. Старый формат также принимается, однако на нашей стороне преобразуется в date) |
start_date | Дата начала акта. Изменен тип данных с timestamp на date (Было “2023-09-14T17:47:46.000000Z”, стало “2023-09-14”. Старый формат также принимается, однако на нашей стороне преобразуется в date) |
end_date | Дата окончания акта. Изменен тип данных с timestamp на date (Было “2023-09-14T17:47:46.000000Z”, стало “2023-09-14”. Старый формат также принимается, однако на нашей стороне преобразуется в date) |
created_at | Дата создания. Формат дат изменен с «2023-09-14T17:47:46.000000Z» на «2023-09-26T09:44:22+03:00» |
Creatives | |
published_at | Дата добавления. Изменен тип данных с timestamp на date (Было “2023-09-14T17:47:46.000000Z”, стало “2023-09-14”. Старый формат также принимается, однако на нашей стороне преобразуется в date) |
created_at | Дата создания. Формат дат изменен с «2023-09-14T17:47:46.000000Z» на «2023-09-26T09:44:22+03:00» |
Statistics | |
date_start_fact | Дата начала показов фактическая. Изменен тип данных с timestamp на date. (Было “2023-09-14T17:47:46.000000Z”, стало “2023-09-14”. Старый формат также принимается, однако на нашей стороне преобразуется в date) |
date_end_fact | Дата окончания показов фактическая. Изменен тип данных с timestamp на date. (Было “2023-09-14T17:47:46.000000Z”, стало “2023-09-14”. Старый формат также принимается, однако на нашей стороне преобразуется в date) |
date_start_plan | Дата начала показов по акту. Изменен тип данных с timestamp на date. (Было “2023-09-14T17:47:46.000000Z”, стало “2023-09-14”. Старый формат также принимается, однако на нашей стороне преобразуется в date) |
date_end_ plan | Дата окончания показов по акту. Изменен тип данных с timestamp на date. (Было “2023-09-14T17:47:46.000000Z”, стало “2023-09-14”. Старый формат также принимается, однако на нашей стороне преобразуется в date) |
created_at | Дата создания. Формат дат изменен с «2023-09-14T17:47:46.000000Z» на «2023-09-26T09:44:22+03:00» |
Тип/свойство | Описание |
---|---|
Сontracts | |
type | Значение - “self_promotion” - договор типа “Самореклама” удаляется. Поле type может принимать только значения - intermediary-contract, contract, additional-agreement. |
Creatives | |
self_promotion_ organization_id | Добавляется свойство - “self_promotion_organization_id”. Данное свойство заполняется в случае, если креатив является саморекламой, во всех остальных случаях равен null. Также в случае, если креатив является саморекламой, поле contract_id равно null. |
InvoiceItems | |
filter[search] | Добавлен фильтр filter[search]. Осуществляет поиск по полям id, contract.number, invoice.number |
Organizations | |
filter[search] | Добавлен фильтр filter[search]. Осуществляет поиск по полям id, name |
CreativeItems | |
Добавлен новый метод загрузки медиа в креатив. Позволяет также добавлять текстовые данные. |
Метод | Описание |
---|---|
POST /auth/ | Получение JWT для авторизации запросов |
REST /organizations | Создание (обновление) данных о контрагентах |
REST /platforms | Создание (обновление) данных о площадках |
REST /contracts | Создание (обновление) данных о договорах |
REST /creatives | Создание (обновление) сведений о креативах |
REST /media | Загрузка медиаданных в креатив |
REST /creatives/items | Загрузка медиа и текстовых данных в креатив посредством создания пункта креатива |
REST /user/media | Привязка медиафайлов к пользователю |
REST /invoices | Создание (обновление) данных об актах |
REST /invoices/items | Создание (обновление) данных о разаллокации актов по договорам |
REST /statistics | Создание (обновление) статистики по креативам |
REST /invoices/items/{id}/creatives | Создание (обновление) данных о разаллокации актов по креативам |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
422 Unprocessable Content | Некорректный запрос |
403 Forbidden | Доступ запрещен, невалидный логин или пароль |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
page | число | нет | Номер страницы |
limit | число | нет | Количество записей на странице |
sort | строка | нет | Используется при get запросе. Сортировка по столбцу. Допустимые значения: id, -id, name, -name, created_at, -created_at, inn, -inn, alternative_inn, -alternative_inn, oksm_number, -oksm_number |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор организации |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not found | Идентификатор организации не найден |
Код ответа | Описание |
---|---|
201 Created | Статистика создана |
401 Unauthorized | Доступ запрещен, невалидный токен |
422 Unprocessable Content | Некорректный запрос |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор организации |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not found | Идентификатор организации не найден |
422 Unprocessable Content | Некорректный запрос |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор организации |
Код ответа | Описание |
---|---|
204 No Content | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
400 Bad Request | У объекта есть зависящие сущности, мешающие удалению |
404 Not found | Идентификатор организации не найден |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор организации |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not found | Идентификатор организации не найден |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
422 Unprocessable Content | Некорректный запрос |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | Идентификатор контрагента |
name | строка (255) | да | Наименование контрагента Длина строки от 1 до 255, может содержать цифры и буквы, а также все спец символы (pattern: ^(?!\s*$)[\s\S]{1,255} Не пустое и не превышает 255) Для типа организации "fl" - Физическое лицо и "ip" - Индивидуальный предприниматель:
|
type | строка (255) | да | Тип организации (контрагента). Возможные значения: ffl - Иностранное физическое лицо;ful - Иностранное юридическое лицо; ip - Индивидуальный предприниматель; fl - Физическое лицо; ul - Юридическое лицо. |
is_ors | булево | да | Является ОРC |
is_rr | булево | да | Является РР |
is_rd | булево | да | Является ли контрагент рекламодателем. По умолчанию значение - false |
is_agent | булево | нет | Является ли рекламным агентом. По умолчанию значение - false |
inn | число | Условно обязательно | ИНН (обязательно для заполнения для Российских организаций) Если тип организации "fl" - Физическое лицо или "ip" - Индивидуальный предприниматель - 12-значный ИНН. Если тип организации "ul" - Юридическое лицо - 10-значный ИНН. |
mobile _phone | строка (15) | Опциональное | Абонентский номер мобильного телефона Обязательно для заполнения для типа организации ffl - Иностранное физическое лицо. Если не заполнено, то должно быть заполнено epayNumber.Номер начинать с + и далее только цифры от 0 до 9. |
epay _number | строка (127) | Опциональное | Обязательно для заполнения для типа организации ffl - Иностранное физическое лицо. Если не заполнено, то должно быть заполнено mobilePhone. |
reg_number | строка (31) | Опциональное | Регистрационный номер, либо его аналог (для иностранных физлиц). Обязательно для заполнения для типа организации ful - иностранное юридическое лицо. Если не заполнено, то должно быть заполнено alternativeInn. |
alternative _inn | строка | Опциональное | Номер налогоплательщика либо его аналог в стране регистрации (для иностранных физ. и юр. лиц) Обязательно для заполнения для типов организации: ful - Иностранное юридическое лицо. Если не заполнено, то должно быть заполнено regNumber;ffl - Иностранное физическое лицо, если стоит признак isOrs=true |
oksm _number | строка (15) | Условно обязательно | Код страны регистрации юрлица в соответствии с ОКСМ Обязательно для заполнения для следующих типов организаций:
|
rs_url | строка (2000) | Условно обязательно | URL рекламной системы. Обязательно для всех типов, если признак is_ors = true Если заполнен, то URL проверяется на протокол http|https |
platforms | массив | Нет | Сведения о площадках (массив id площадок созданных в методе POST /platforms) |
owned _platforms | массив | Нет | Передается массив id площадок, для которых данный контрагент является владельцем. Внимание! площадки, указанные в owned_platforms, должны также передаваться в platforms |
external_id | строка | нет | Учетный идентификатор в базе пользователя |
partners | массив | нет | Массив id параметров партнерских организаций |
dependent _relationships | массив | не заполняется | Связанные (дочерние) объекты. Пример: "dependent_relationships": [ { "name": "contract", "id": 33174 } |
include | Строка | нет | Параметр для получения статусов сущностей для GET запроса, значение – erirEntity пример использования (https://api.ord-a.ru/api/v2/organizations?include=erirEntity)В json ответе от сервера появятся данные: … "erir_entity": { "id": 10423, "status": "Зарегистрирован", "status_label": "registered", "last_item": { "id": 15069, "status": "Зарегистрирован", "status_label": "registered", "errors": [], "message": null, "created_at": "2024-07-17T10:50:26+03:00", "pending_at": "2024-07-17T10:55:26+03:00", "status_changed_at": "2024-07-17T12:56:04+03:00" }, "registered_at": "2024-07-17 12:56:04", "created_at": "2024-07-17T10:50:25+03:00" } ... |
filter [option] | строка (255) | нет | Параметр для поиска записей сущностей для GET запроса, допустимые значения: https://api.ord-a.ru/api/v2/organizations/?include=lastEntity&limit=10&page=1&filter[id]=4 |
sort | строка (255) | нет | Параметр для сортировки массива сущностей для GET запроса, допустимые значения: id, -id, - name, -name, created_at, -created_at, inn, -inn, alternative_inn, -alternative_inn, oksm_number, -oksm_number. Пример запроса:https://api.ord-a.ru/api/v2/organizations?sort=name |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
page | число | нет | Номер страницы |
limit | число | нет | Количество записей на странице |
sort | строка | нет | Используется при get запросе. Сортировка по столбцу. Допустимые значения: id, -id, name, -name, type, -type, url, -url |
Код ответа | Описание |
---|---|
200 ОК | Положительный статус запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор площадки |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not found | Идентификатор площадки не найден |
Код ответа | Описание |
---|---|
201 Created | Площадка создана |
401 Unauthorized | Доступ запрещен, невалидный токен |
422 Unprocessable Content | Некорректный запрос |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор площадки |
Код ответа | Описание |
---|---|
200 ОК | Запрос выполнен удачно |
422 Unprocessable Content | Некорректный запрос |
401 Forbidden | Доступ запрещен, невалидный токен |
404 Not Found | Площадка не найдена |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор площадки |
Код ответа | Описание |
---|---|
204 No Content | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
400 Bad Request | У объекта есть зависящие сущности, мешающие удалению |
404 Not Found | Идентификатор площадки не найден |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор площадки |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not Found | Идентификатор площадки не найден |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | Идентификатор контрагента |
type | строка (255) | да | Тип площадки. Возможные значения: |
name | строка (100) | да | Название сайта (блога) или приложения или иные способы адресации |
url | строка (2000) | да | URL площадки или приложения в сторе. Проверка URL:Проверить протокол http|https |
owner _organization_id | число | Нет | Указывается id организации-владельца площадки |
external_id | строка | нет | Учетный идентификатор в базе пользователя |
dependent _relationships | массив | не заполняется | Связанные (дочерние) объекты. Пример: "dependent_relationships": [ { "name": "statistics", "id": 221 } |
limit | число | нет | Используется при get запросе. Количество записей при пагинации на странице. |
page | число | нет | Используется при get запросе. Номер страницы при пагинации на странице |
sort | строка (255) | нет | Используется при get запросе. Сортировка по столбцу. Допустимые значения: name, -name, created_at, -created_at, inn, -inn, alternative_inn, -alternative_inn, oksm_number, -oksm_number |
include | Строка | нет | Параметр для получения статусов сущностей для GET запроса, значение – erirEntity пример использования (https://api.ord-a.ru/api/v2/platforms?include=erirEntity)В json ответе от сервера появятся данные: ... "erir_entity": { "id": 10424, "status": "Зарегистрирован", "status_label": "registered", "last_item": { "id": 15104, "status": "Зарегистрирован", "status_label": "registered", "errors": [], "message": null, "created_at": "2024-07-17T11:18:09+03:00", "pending_at": "2024-07-17T11:23:09+03:00", "status_changed_at": "2024-07-17T13:21:03+03:00" }, "registered_at": "2024-07-17 13:21:03", "created_at": "2024-07-17T11:18:08+03:00" } … |
filter[option] | строка | нет | Параметр для поиска записей сущностей для GET запроса, допустимые значения: https://api.ord-a.ru/api/v2/platforms/?include=lastEntity&limit=10&page=1&filter[id]=4 |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
page | число | нет | Номер страницы |
limit | число | нет | Количество записей на странице |
sort | строка | нет | Используется при get запросе. Сортировка по столбцу. Допустимые значения: id, -id, number, -number, date, -date, type, -type, amount, -amount |
Код ответа | Описание |
---|---|
200 ОК | Информация о договорах |
401 Unauthorized | Доступ запрещен |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор площадки |
Код ответа | Описание |
---|---|
200 ОК | Запрос успешно прошел |
401 Unauthorized | Доступ запрещен |
404 Not Found | Идентификатор договора не найден |
Код ответа | Описание |
---|---|
201 Created | Договор создан |
401 Unauthorized | Доступ запрещен |
422 Unprocessable Content | Ошибка во входных данных |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор площадки |
Код ответа | Описание |
---|---|
200 ОК | Статус успешного запроса |
401 Unauthorized | Доступ запрещен |
404 Not found | Идентификатор договора не найден |
422 Unprocessable Content | Ошибка во входных данных |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор площадки |
Код ответа | Описание |
---|---|
204 No Content | Статус успешного запроса |
400 Bad Request | У объекта есть зависящие сущности, мешающие удалению |
401 Unauthorized | Доступ запрещен, невалидный токен |
404 Not found | Идентификатор креатива не найден |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
id | число | да | идентификатор площадки |
Код ответа | Описание |
---|---|
200 ОК | Запрос прошел успешно |
401 Unauthorized | Доступ запрещен |
422 Unprocessable Content | Некорректный запрос |
Код ответа | Описание |
---|---|
200 ОК | Запрос прошел успешно |
401 Unauthorized | Доступ запрещен |
422 Unprocessable Content | Некорректный запрос |
Параметр | Тип | Обязательность | Описание |
---|---|---|---|
type | строка (255) | да | Тип договора. Возможные значения:
intermediary-contract - Посреднический договор; для договора с type = "additional-agreement" нельзя указать в parent_contract_id договор с type= "additional-agreement" |
cid | строка | Условно обязательно | Передается CID внешнего договора. Указывается, если type=external. |
agent _acting_for _publisher | булево | Условно обязательно | Агент представляет сторону принципала."Обязательно для типа договора "intermediary-contract" - Посреднический договор |
client_id | число | да | Идентификатор контрагент - заказчик. Заказчик и Исполнитель не могут иметь один и тот же идентификатор, а также иметь один и тот же ИНН. |
contractor_id | число | да | Идентификатор контрагент-исполнителя должен быть отличным от client_id |
parent _сontract _id | число | Условно обязательно | Идентификатор основного (родительского) договора (обязательно для доп соглашений). Если создаем основной договор передаем “null” |
is_reg_report | булево | да | На контрагенте-исполнителе лежит обязанность регистрировать и репортить креативы. Возможные значения: true/ false |
action | строка (255) | Условно обязательно | Описание осуществляемых посредником-представителем действий. Обязательно, если тип договора intermediary-contract. Возможные значения: other - Иное;distribution - Действия в целях распространения рекламы; conclude - Заключение договоров; commercial - Коммерческое представительство. |
subject | строка (255) | да | Сведения о предмете договора. Возможные значения:other - Иное; org-distribution - Договор на организацию распространения рекламы; mediation - Посредничество; distribution - Договор на распространение рекламы; representation – Представительство |
number | строка (255) | нет | Номер договора. |
date | дата (date) | да | Дата договора в формате ГГГГ-мм-дд 1. Дата должна быть не ниже, чем 01.01.19912. Дата должна быть меньше или равна текущей дате |
expiration_date | дата (date) | нет | Дата договора в формате ГГГГ-мм-дд Дата в expiration_date должна быть позже, либо равна дате договора (date) |
amount | число | нет | Сумма договора. Положительные числа или нулевыеФормат: два знака после запятой, разделитель - точка 22.23 12 цифр до точки, т.е. максимальное число, которое может быть передано = 999 999 999 999
|
external_id | строка (255) | нет | Учетный идентификатор в базе пользователя |
limit | число | нет | Используется при get запросе. Количество записей при пагинации на странице. |
page | число | нет | Используется при get запросе. Номер страницы при пагинации на странице |
sort | строка | нет | Используется при get запросе. Сортировка по стоблцу. Допустимые значения: id, -id, number, -number, date, -date, type, -type, amount, -amount |
dependent_relationships | массив | не заполняется | Связанные (дочерние) объекты. Пример: "dependent_relationships": [ {"name": "child_contracts", "id": 435}, {"name": "invoice_items", "id": 49}, {"name": "invoices", "id": 316}, {"name": "creatives", "id": 454} ] |
include | Строка | нет | Параметр для получения статусов сущностей для GET запроса, значение – erirtEntity пример использования (https://api.ord-a.ru/api/v2/ contracts?include=erirEntity)В json ответе от сервера появятся данные: ... "erir_entity": { "id": 10345, "status": "Зарегистрирован", "status_label": "registered", "last_item": { "id": 14957, "status": "Зарегистрирован", "status_label": "registered", "errors": [], "message": null, "created_at": "2024-07-15T09:44:44+03:00", "pending_at": "2024-07-15T09:49:44+03:00", "status_changed_at": "2024-07-17T17:07:03+03:00" }, "registered_at": "2024-07-17 17:07:03", "created_at": "2024-07-15T09:44:41+03:00" } ... |
filter[option] | строка | нет | Параметр для поиска записей сущностей для GET запроса, допустимые значения: https://api.ord-a.ru/api/v2/ contracts /?filter[id]=4 |