Раздел “Публикации”
Действие: Создание публикации
Метод: POST
URL: https://back.stage-ord.socialjet.pro/api/v1/publication
Request:
| Ключ | Описание | Тип | Обязательность | Дефолтно | Связь | Комментарии |
| agentId | ID юр. лица | INT | Да | - | Agent.id | - |
| campaignId | ID РК | INT | Нет | - | Campaign.id | - |
| creativeId | ID креатива | INT | Да | - | Crative.id | - |
| productId | ID продукта | INT | Да | - | CompanyProduct.id | - |
| platformId | ID площадки | INT | Да | - | Platform.id | - |
| contactId | ID контактов | INT | Да | - | Contacts.id | - |
| creativeOrdMark | Маркировка в ОРД | String | Нет | NOT_PRESENT | - | - |
| formatId | ID формата публикации | INT | Нет | - | PlacementFormat.id | - |
| customName | Кастомное наименование услуги | Boolean | Нет | false | - | - |
| pricePurchaseWithoutDiscount | Стоимость закупки без скидки, с налогом исполнителя | Int | Нет | - | - | - |
| pricePurchaseWithDiscount | Стоимость закупки со скидкой, с налогом исполнителя | Int | Нет | - | - | - |
| purchaseTax | Налог исполнителя | Int | Нет | - | - | - |
| saleWithoutSkWithoutTax | Продажа без СК, без НДС | Int | Нет | - | - | - |
| sk | СК (супер комиссия) | Int | Нет | - | - | - |
| fee3percent | 3% сбор | Int | Нет | - | - | - |
| priceClientWithoutTax | Стоимость для клиента до НДС | Int | Нет | - | - | - |
| priceClientWithTax | Стоимость для клиента с НДС | Int | Нет | - | - | - |
| profit | Чистая прибыль (маржинальность) | Int | Нет | - | - | - |
| startDate | Плановая дата публикации | DateTime | Нет | - | - | - |
| endDate | Плановая дата удаления | DateTime | Нет | - | - | Для “Без -удаления” выставить null |
| startDateActual | Фактическая дата публикации | DateTime | Нет | - | - | - |
| endDateActual | Фактическая дата удаления | DateTime | Нет | - | - | Если null, то “Дата удаления неизвестна” |
| status | Статус публикации | String | Нет | - | - | - |
| link | Ссылка на публикацию | String | Да | - | - | - |
| ordToken | Токен ОРД | String | Нет | - | - | - |
Response:
| Статус | Описание | Объект | Комментарий |
| 201 | Success | Publication | Объект публикации |
| 400 | Error | - | Ошибка |
| 500 | Error | - | Ошибка |
Действие: Обновление публикации
Метод: PUT
URL: https://back.stage-ord.socialjet.pro/api/v1/publication/{ID}
Params:
| Ключ | Описание | Тип | Обязательность | Дефолтно | Связь |
| ID | ID публикации | INT | Да | - | Publication.id |
Request:
| Ключ | Описание | Тип | Обязательность | Дефолтно | Связь | Комментарии |
| agentId | ID юр. лица | INT | Нет | - | Agent.id | - |
| campaignId | ID РК | INT | Нет | - | Campaign.id | - |
| creativeId | ID креатива | INT | Нет | - | Crative.id | - |
| productId | ID продукта | INT | Нет | - | CompanyProduct.id | - |
| platformId | ID площадки | INT | Нет | - | Platform.id | - |
| contactId | ID контактов | INT | Нет | - | Contacts.id | - |
| creativeOrdMark | Маркировка в ОРД | String | Нет | - | - | - |
| formatId | ID формата публикации | INT | Нет | - | PlacementFormat.id | - |
| customName | Кастомное наименование услуги | Boolean | Нет | - | - | - |
| pricePurchaseWithoutDiscount | Стоимость закупки без скидки, с налогом исполнителя | Int | Нет | - | - | - |
| pricePurchaseWithDiscount | Стоимость закупки со скидкой, с налогом исполнителя | Int | Нет | - | - | - |
| purchaseTax | Налог исполнителя | Int | Нет | - | - | - |
| saleWithoutSkWithoutTax | Продажа без СК, без НДС | Int | Нет | - | - | - |
| sk | СК (супер комиссия) | Int | Нет | - | - | - |
| fee3percent | 3% сбор | Int | Нет | - | - | - |
| priceClientWithoutTax | Стоимость для клиента до НДС | Int | Нет | - | - | - |
| priceClientWithTax | Стоимость для клиента с НДС | Int | Нет | - | - | - |
| profit | Чистая прибыль (маржинальность) | Int | Нет | - | - | - |
| startDate | Плановая дата публикации | DateTime | Нет | - | - | - |
| endDate | Плановая дата удаления | DateTime | Нет | - | - | Для “Без -удаления” выставить null |
| startDateActual | Фактическая дата публикации | DateTime | Нет | - | - | - |
| endDateActual | Фактическая дата удаления | DateTime | Нет | - | - | Если null, то “Дата удаления неизвестна” |
| status | Статус публикации | String | Нет | - | - | - |
| link | Ссылка на публикацию | String | Нет | - | - | - |
| ordToken | Токен ОРД | String | Нет | - | - | - |
Response:
| Статус | Описание | Объект | Комментарий |
| 200 | Success | Publication | Объект публикации |
| 400 | Error | - | Ошибка |
| 404 | Not Found | - | Отсутствует креатив |
| 500 | Error | - | Ошибка |
Действие: Удаление публикации
Метод: DELETE
URL: https://back.stage-ord.socialjet.pro/api/v1/publication/{ID}
Params:
| Ключ | Описание | Тип | Обязательность | Дефолтно | Связь |
| ID | ID публикации | INT | Да | - | Publication.id |
Response:
| Статус | Описание | Объект | Комментарий |
| 20 | Success | - | Успех |
| 400 | Error | - | Ошибка |
| 500 | Error | - | Ошибка |
Действие: Получение публикации
Метод: GET
URL: https://back.stage-ord.socialjet.pro/api/v1/publication/{ID}
Params:
| Ключ | Описание | Тип | Обязательность | Дефолтно | Связь |
| ID | ID публикации | INT | Да | - | Publication.id |
Request:
| Ключ | Описание | Тип | Обязательность | Дефолтно | Связь | Комментарии |
| id | ID услуги | INT | Да | AI | - | - |
| authorId | ID автора креатива | INT | Да | - | User.id | - |
| agentId | ID юр. лица | INT | Нет | - | Agent.id | - |
| campaignId | ID РК | INT | Нет | - | Campaign.id | - |
| creativeId | ID креатива | INT | Нет | - | Crative.id | - |
| productId | ID продукта | INT | Нет | - | CompanyProduct.id | - |
| platformId | ID площадки | INT | Нет | - | Platform.id | - |
| contactId | ID контактов | INT | Нет | - | Contacts.id | - |
| creativeOrdMark | Маркировка в ОРД | String | Нет | - | - | - |
| formatId | ID формата публикации | INT | Нет | - | PlacementFormat.id | - |
| customName | Кастомное наименование услуги | Boolean | Нет | - | - | - |
| pricePurchaseWithoutDiscount | Стоимость закупки без скидки, с налогом исполнителя | Int | Нет | - | - | - |
| pricePurchaseWithDiscount | Стоимость закупки со скидкой, с налогом исполнителя | Int | Нет | - | - | - |
| purchaseTax | Налог исполнителя | Int | Нет | - | - | - |
| saleWithoutSkWithoutTax | Продажа без СК, без НДС | Int | Нет | - | - | - |
| sk | СК (супер комиссия) | Int | Нет | - | - | - |
| fee3percent | 3% сбор | Int | Нет | - | - | - |
| priceClientWithoutTax | Стоимость для клиента до НДС | Int | Нет | - | - | - |
| priceClientWithTax | Стоимость для клиента с НДС | Int | Нет | - | - | - |
| profit | Чистая прибыль (маржинальность) | Int | Нет | - | - | - |
| startDate | Плановая дата публикации | DateTime | Нет | - | - | - |
| endDate | Плановая дата удаления | DateTime | Нет | - | - | Для “Без -удаления” выставить null |
| startDateActual | Фактическая дата публикации | DateTime | Нет | - | - | - |
| endDateActual | Фактическая дата удаления | DateTime | Нет | - | - | Если null, то “Дата удаления неизвестна” |
| status | Статус публикации | String | Нет | - | - | - |
| link | Ссылка на публикацию | String | Нет | - | - | - |
| ordToken | Токен ОРД | String | Нет | - | - | - |
| createdAt | Дата добавления | DateTime | Да | - | - | - |