О компании
Новости
Регистрация
Помощь
Контакты
Документы
Подключение к API ОРД-А (V2)
Обновления от 13.03.24
Тип/свойство Описание
Creative
okveds Расширен паттерн для ОКВЭД (длина значения ОКВЭД может составлять от 3 до 6 символов)

Напоминание: ОКВЭД более не обязателен. Если не указывается, в ЕРИР отправляется 00.00 (проставляется нами автоматом)
is_media Данный параметр был удален
Обновления от 06.02.24
Тип/свойство Описание
Platform
owner_organization_id Необязательное поле, в котором указывается id организации-владельца площадки
url Проверка на протоколы http:// и https://
name Ограничено до 100 символов
Organization
owned_platforms Необязательное поле. Передается массив id площадок, для которых данный контрагент является владельцем.
Сontracts
number Расширено до 255 символов
type=additional-agreement При создании доп. соглашения (additional-agreement) запрещается привязывать родительский договор (parent_сontract_id), в котором client_id (Идентификатор контрагент - заказчик) и contractor_id (Идентификатор контрагент-исполнителя) отличается от client_id и contractor_id создаваемого доп. соглашения
Invoice
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"
Statistic
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
Обновления от 27.12.23
Тип/свойство Описание
Creative, Invoice
status Новый статус отправки "status": "Ожидание данных". Выводится для объектов creatives без медиа или текстовых данных и invoices без invoice_items.

Внимание! Не выводится для объектов, созданных до данного релиза.
Примечание: Объекты с таким статусом не будут отправлены в ЕРИР без соответствующих данных.
Creative
filter[statistics] Фильтр по поиску креативов со статистикой filter[statistics]=with и без статистики filter[statistics]=without
Creative, Invoice
filter[status]=6 Фильтр по поиску статуса «Ожидание данных»
Обновления от 29.11.23
Тип/свойство Описание
Invoice
DELETE
/invoices/{id}?relations=true		 Метод удаления акта.
Внимание! Удаляются также связанные сущности (invoice_items и statistics)
Statistic
amount Валидация: если amount_per_show = 0, то amount не может быть больше 0
Обновления от 31.10.23
Тип/свойство Описание
Platform, Organization, Сontracts, Creative, Statistic, Invoice
include=erirEntity Фильтр для получения статусов об отправки данных в ЕРИР изменен с include=lastErirStat на include=erirEntity
Platform, Organization, Сontracts, Creative, Statistic, Invoice
erir_entity В get запросах при использовании фильтра include=lastErirStat название поля "erir_stat" меняется на "erir_entity"
Platform, Organization, Сontracts, Creative, Statistic, Invoice
erir_entity В get запросах по id объекта (например, GET /platforms/{id} ) в теле объекта возвращается статус отправки в ЕРИР в виде
{
…
"erir_entity": {
"message": null,
"status": "Зарегистрирован"
},
…
}
Обновления от 26.09.23
Тип/свойство Описание
С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.
InvoiceItem
filter[search] Добавлен фильтр filter[search]. Осуществляет поиск по полям id, contract.number, invoice.number
Organization
filter[search] Добавлен фильтр filter[search]. Осуществляет поиск по полям id, name
CreativeItems
Добавлен новый метод загрузки медиа в креатив. Позволяет также добавлять текстовые данные.
Сравнительная таблица различий методов версий V1 и V2 доступна в разделе 3.15
1. Вводные данные
URL для обращения к API: https://api.ord-a.ru/api/v2/
2. JWT Авторизация
Авторизация и аутентификация при обращении к API осуществляется при помощи JSON Web Token (JWT), который необходимо указывать в заголовке Authorization. Пример:
curl --location --request POST 'https://api.ord-a.ru/api/v2/invoices/items \ --header 'Authorization: Bearer your_api_token' \ --header 'Content-Type: application/json' \ --data-raw '{"contract_id": 6, "amount": 0, "is_vat": true}'
3. Методы API
В описании эндпоинтов указан http метод для выполнения запросов. Если указан REST, то используется общепринятая схема http методов:

POST – создание

GET – получение списка, c передачей фильтров по названию полей в query

GET метод/id_объекта / - получение объекта запроса по его id

PUT метод/id_объекта/ - обновление объекта

DELETE – удаление объектов. Доступно в organizations, platforms, contracts и creatives.

В запросах получения списка есть параметры для пагинации total и pages, в параметры запроса можно отправлять:

skip – отступ от начала списка (количество объектов),

limit – количество объектов в одном запросе

например, https://api.ord-a.ru/api/v2/platforms?skip=15&limit=10 , вернёт 10 площадок, которые идут после первых 15 в списке.
Метод Описание
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 Создание (обновление) данных о разаллокации актов по креативам
3.1. Авторизация: POST /auth
При истечении указанной даты в expires_at, необходимо заново отправить запрос и получить новый JWT
Код ответа Описание
200 ОК Статус успешного запроса
422 Unprocessable Content Некорректный запрос
403 Forbidden Доступ запрещен, невалидный логин или пароль
Пример запроса:
{
"email": "test@test-a.ru",
"password": "test "
}
Пример ответа:
{
"data": {
"access_token": "...",
"expires_at": "2024-06-07T12:40:10.000000Z"
},
"message": "access_token успешно создан"
}
3.2. Контрагенты (Organizations)
3.2.1 Получение сведений о контрагентах: GET /organizations
https://api.ord-a.ru/api/v2/organizations
Параметры запроса:
Параметр Тип Обязательность Описание
page число нет Номер страницы
limit число нет Количество записей на странице
sort строка нет Используется при get запросе. Сортировка по столбцу. Допустимые значения: name, -name, created_at, -created_at, inn, -inn, alternative_inn, -alternative_inn, oksm_number, -oksm_number
Данный метод вернет сведения о всех заведенных контрагентах.
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
Пример запроса:
curl -X 'GET' \
'https://api.ord-a.ru/api/v2/organizations' \
-H 'accept: application/json' \
-H 'Authorization: Bearer TOKEN' \
-H 'X-CSRF-TOKEN: '
Пример успешного ответа:
{
"data": [
{
"id": 14166,
"name": "Первое имя",
"is_partner": false,
"membership_id": 1,
"type": "ul",
"is_ors": true,
"is_rr": false,
"is_rd": false,
"inn": "7613946079",
"mobile_phone": null,
"epay_number": null,
"reg_number": null,
"alternative_inn": null,
"oksm_number": null,
"rs_url": "https://my-dev.ord-a.ru",
"legal_address": {
"city": null,
"street": null,
"building": null,
"postcode": null
},
"post_address": {
"city": null,
"street": null,
"building": null,
"postcode": null
},
"is_agent": false,
"platforms": [
326009
],
"owned_platforms": [
326009
],
"created_at": "2024-02-19T13:33:31+03:00",
"deleted_at": null,
"external_id": null
},
{
"id": 14165,
"name": "Имя второе",
"is_partner": false,
"membership_id": 1,
"type": "fl",
"is_ors": true,
"is_rr": false,
"is_rd": false,
"inn": "277332520750",
"mobile_phone": null,
"epay_number": null,
"reg_number": null,
"alternative_inn": null,
"oksm_number": null,
"rs_url": "https://my-dev.ord-a.ru",
"legal_address": {
"city": "г Москва",
"street": "Ленина",
"building": "1",
"postcode": "123456"

},
"post_address": {
"city": "г Москва",
"street": "Ленина",
"building": "1",
"postcode": "123456"
},
"is_agent": false,
"platforms": [
326008
],
"owned_platforms": [],
"created_at": "2024-02-19T10:41:40+03:00",
"deleted_at": null,
"external_id": null
}
],
"links": {
"first": "http://api.ord-a.ru/api/v2/organizations?page=1",
"last": "http://aapi.ord-a.ru/api/v2/organizations?page=16",
"prev": null,
"next": "http://api.ord-a.ru/api/v2/organizations?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Вперед",
"active": false
},
{
"url": "http://api.ord-a.ru/api/v2/organizations?page=1",
"label": "1",
"active": true
},
{
"url": "http://api.ord-a.ru/api/v2/organizations?page=2",
"label": "2",
"active": false
},

],
"path": "http://api.ord-a.ru/api/v2/organizations",
"per_page": 2,
"to": 1,
"total": 2
}
}
3.2.2 Получение сведений определенного контрагента: GET /organizations/{id}
https://api.ord-a.ru/api/v2/organizations/{id}
Данный метод вернет сведения определенного контрагента.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор организации
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Идентификатор организации не найден
Пример запроса:
curl -X 'GET' \
'https://api.ord-a.ru/api/v2/organizations/14166' \
-H 'accept: application/json' \
-H 'Authorization: Bearer TOKEN' \
-H 'X-CSRF-TOKEN: '
Пример успешного ответа:
{
"data": {
"id": 14166,
"name": "Первое имя",
"is_partner": false,
"membership_id": 1,
"erir_entity": {
"id": null,
"message": null,
"status": "В очереди на отправку",
"status_label": "pending",
"payload": null,
"created_at": null,
"pending_at": null
},
"type": "ul",
"is_ors": true,
"is_rr": false,
"is_rd": false,
"inn": "7613946079",
"mobile_phone": null,
"epay_number": null,
"reg_number": null,
"alternative_inn": null,
"oksm_number": null,
"rs_url": "https://my-dev.ord-a.ru",
"legal_address": {
"city": null,
"street": null,
"building": null,
"postcode": null
},
"post_address": {
"city": null,
"street": null,
"building": null,
"postcode": null
},
"is_agent": false,
"platforms": [
326009
],
"owned_platforms": [
326009
],
"created_at": "2024-02-19T13:33:31+03:00",
"deleted_at": null,
"external_id": null
}
}
3.2.3 Создание контрагента: POST /organizations
https://api.ord-a.ru/api/v2/organizations
Данный метод используется для создания сведений о контрагентах.
Код ответа Описание
201 Created Статистика создана
401 Unauthorized Доступ запрещен, невалидный токен
422 Unprocessable Content Некорректный запрос
Пример запроса:
curl -X 'POST' \
'https://api.ord-a.ru/api/v2/organizations' \
-H 'accept: application/json' \
-H 'Authorization: Bearer TOKEN' \
-H 'Content-Type: application/json' \
-H 'X-CSRF-TOKEN: ' \
-d '{
"name": "Третье имя",
"type": "ul",
"is_ors": true,
"is_rr": false,
"is_rd": false,
"inn": "7613946079",
"rs_url": "https://my-dev.ord-a.ru",
"platforms": [
326404, 326390
],
"owned_platforms": [
326404
],
"disable_platform_sync": false,
"external_id": "123"
}'
Успешный ответ:
{
"data": {
"id": 14168,
"name": "Третье имя",
"is_partner": false,
"membership_id": 1,
"type": "ul",
"is_ors": true,
"is_rr": false,
"is_rd": false,
"inn": "7613946079",
"mobile_phone": null,
"epay_number": null,
"reg_number": null,
"alternative_inn": null,
"oksm_number": null,
"rs_url": "https://my-dev.ord-a.ru",
"legal_address": {
"city": null,
"street": null,
"building": null,
"postcode": null
},
"post_address": {
"city": null,
"street": null,
"building": null,
"postcode": null
},
"is_agent": false,
"platforms": [
326404,
326390
],
"owned_platforms": [
326404
],
"created_at": "2024-02-26T10:40:48+03:00",
"deleted_at": null,
"external_id": "123"
}
}
3.2.4 Обновление контрагента: PUT /organizations/{id}
https://api.ord-a.ru/api/v2/organizations/{id}
Данный метод используется для создания сведений о контрагентах.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор организации
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Идентификатор организации не найден
422 Unprocessable Content Некорректный запрос
Пример запроса:
curl -X 'PUT' \
'https://api.ord-a.ru/api/v2/organizations/14168' \
-H 'accept: application/json' \
-H 'Authorization: Bearer TOKEN' \
-H 'Content-Type: application/json' \
-H 'X-CSRF-TOKEN: ' \
-d '{
"name": "Измененное имя",
"type": "ul",
"is_ors": true,
"is_rr": false,
"is_rd": false,
"inn": "7613946079",
"rs_url": "https://local.ru",
"platforms": [
326404, 326390
],
"owned_platforms": [
326404
],
"disable_platform_sync": false,
"external_id": "123"
}'
Успешный ответ:
{
"data": {
"id": 14168,
"name": "Измененное имя",
"is_partner": false,
"membership_id": 1,
"erir_entity": {
"id": 44368,
"message": null,
"status": "В очереди на отправку",
"status_label": "pending",
"payload": {
"id": 14168,
"type": "ul",
"isOrs": true,
"isRr": false,
"inn": "7613946079",
"name": "Измененное имя",
"mobilePhone": null,
"epayNumber": null,
"regNumber": null,
"alternativeInn": null,
"oksmNumber": null,
"rsUrl": "https://local.ru",
"platforms": [
{
"platformId": 326404,
"type": "apps",
"isOwned": true,
"name": "этот",
"url": "https://my-dev.ord-a.ru/acts/form/",
"report": {
"reporterId": 12937,
"createdDatetimeInOrd": "2024-02-22 08:04:15.000000",
"updatedDatetimeInOrd": "2024-02-26 21:40:48.000000"
}
},
{
"platformId": 326390,
"type": "site",
"isOwned": false,
"name": "Тестовая",
"url": "https://my-dev.ord-a.ru",
"report": {
"reporterId": 12937,
"createdDatetimeInOrd": "2024-02-19 21:15:48.000000",
"updatedDatetimeInOrd": "2024-02-26 21:32:50.000000"
}
}
],
"report": {
"reporterId": 12937,
"createdDatetimeInOrd": "2024-02-26 21:40:48.000000",
"updatedDatetimeInOrd": "2024-02-26 21:55:54.000000"
}
},
"created_at": "2024-02-26T10:40:48+03:00",
"pending_at": "2024-02-26T10:45:48+03:00"
},
"type": "ul",
"is_ors": true,
"is_rr": false,
"is_rd": false,
"inn": "7613946079",
"mobile_phone": null,
"epay_number": null,
"reg_number": null,
"alternative_inn": null,
"oksm_number": null,
"rs_url": "https://local.ru",
"legal_address": {
"city": null,
"street": null,
"building": null,
"postcode": null
},
"post_address": {
"city": null,
"street": null,
"building": null,
"postcode": null
},
"is_agent": false,
"platforms": [
326404,
326390
],
"owned_platforms": [
326404
],
"created_at": "2024-02-26T10:40:48+03:00",
"deleted_at": null,
"external_id": "123"
}
}
 3.2.5 Удаление контрагента: DELETE /organizations/{id}
https://api.ord-a.ru/api/v2/organizations/{id}
Данный метод используется для удаления сведений о контрагенте.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор организации
Код ответа Описание
204 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Идентификатор организации не найден
3.2.6 Восстановление контрагента: GET /organizations/{id}/restore
https://api.ord-a.ru/api/v2/organizations/{id}/restore
Данный метод используется для восстановления сведений о контрагенте.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор организации
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Идентификатор организации не найден
3.2.7 Массовое добавление, обновление данных об организации: GET /organizations/upsert
https://api.ord-a.ru/api/v2/organizations/upsert
Данный метод используется для массового добавления, обновления данных о контрагентах.
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
422 Unprocessable Content Некорректный запрос
Пример запроса обновления:
 curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/organizations/upsert' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
 "organizations": [
    {
    "id": 14168,
    "name": "Измененное имя",
   "type": "ul",
   "is_ors": true,
    "is_rr": false,
    "is_rd": false,
    "inn": "7613946079",
    "rs_url": "https://local.ru",
    "platforms": [
        326404
    ],
    "owned_platforms": [
        326404
    ],
   "external_id": "123"
    },
    {
    "id": 14167,
    "name": "Тест",
   "type": "ul",
   "is_ors": false,
    "is_rr": true,
    "is_rd": false,
    "inn": "7613946079",
    "rs_url": "https://my-dev.ord-a.ru",
    "platforms": [
        326390
    ],
   "external_id": "43"
    }
  ]
}'
Успешный ответ:
{
    "data": [
        {
            "id": 14168,
            "external_id": "43"
        },
        {
            "id": 25197,
            "external_id": "123"
        }
    ],
    "message": "OK"
}
3.2.8 Атрибуты объекта «Контрагенты» (Organizations):
Параметр Тип Обязательность Описание
id число да Идентификатор контрагента
name строка (255) да

Наименование контрагента

Длина строки от 1 до 255, может содержать цифры и буквы, а также все спец символы (pattern: ^(?!\s*$)[\s\S]{1,255} Не пустое и не превышает 255)

Для типа организации "fl" - Физическое лицо и "ip" - Индивидуальный предприниматель:
  1. Только русские буквы.
  2. Допускается пробел (не более одного между словами. При этом в начале и в конце пробелов не должно быть).
  3. Допускается тире (не более одного между словами. При этом в начале и в конце тире не должно быть).
  4. Символы римских чисел: I, V, X, L, C, D, M
Для типа организации "ul" - юридическое лицо:
  1. В названии контрагента могут использоваться только буквы русского алфавита, цифры и символы: пробел, кавычки, круглые скобки, “-”, “–”, ”—”, “&”, “#”, “,”, “.”, “;”, “!”,, “?”, “‘”, “`”, “+”, “*”, “№”, “/”, “:”, “|”, “_”, “%”, “°”, “«”, “»”, "'".
  2. Название контрагента не должно состоять только из одних символов: пробел, кавычки, круглые скобки, “-”, “–”, ”—”, “&”, “#”, “,”, “.”, “;”, “!”,, “?”, “‘”, “`”, “+”, “*”, “№”, “/”, “:”, “|”, “_”, “%”, “°”, “«”, “»”.
  3. В начале и в конце не должно быть пробелов.
  4. Символы римских чисел: I, V, X, L, C, D, M
Для типов организаций "ffl" - Иностранное физическое лицо и "ful" - Иностранное юридическое лицо:
  1. В названии контрагента могут использоваться только буквы русского или латинского алфавитов, цифры и символы: пробел, кавычки, круглые скобки, “-”, “–”, ”—”, “&”, “#”, “,”, “.”, “;”, “!”,, “?”, “‘”, “`”, “+”, “*”, “№”, “/”, “:”, “|”, “_”, “%”, “°”, “«”, “»”, "'".
  2. Название контрагента не должно состоять только из одних символов: пробел, кавычки, круглые скобки, “-”, “–”, ”—”, “&”, “#”, “,”, “.”, “;”, “!”,, “?”, “‘”, “`”, “+”, “*”, “№”, “/”, “:”, “|”, “_”, “%”, “°”, “«”, “»”.
  3. В начале и в конце не должно быть пробелов.
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) Условно обязательно

Код страны регистрации юрлица в соответствии с ОКСМ

Обязательно для заполнения для следующих типов организаций:
  1. ffl - Иностранное физическое лицо;
  2. ful - Иностранное юридическое лицо.
  3. В начале и в конце не должно быть пробелов.
Если заполнено - длина строки 3 цифры
rs_url строка (2000) Условно обязательно

URL рекламной системы.

Обязательно для всех типов, если признак is_ors = true

Если заполнен, то
Проверка URL:
Проверить протокол http|https
platforms массив Опциональное

Сведения о площадках (массив id площадок созданных в методе POST /platforms)

Обязательно если is_ors или is_rr = true. Если оба признака false, то площадки не будут зарегистрированы.
owned _platforms массив Нет

Передается массив id площадок, для которых данный контрагент является владельцем.

Внимание! площадки, указанные в owned_platforms, должны также передаваться в platforms
external_id строка нет Учетный идентификатор в базе пользователя
partners массив нет Массив id параметров партнерских организаций
legal _address строка (255) нет Юр адрес
post _address строка (255) нет Почтовый адрес
include Строка нет

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

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

Параметр для поиска записей сущностей для GET запроса, допустимые значения:
- id;
-name;
-created_at;
-inn;
-oksm_number;
-external_id;
-status (1, 2, 3, 4, 10)

Пример запроса:

https://api.ord-a.ru/api/v2/organizations/?include=lastEntity&limit=10&page=1&filter[id]=4
sort строка (255) нет

Параметр для сортировки массива сущностей для GET запроса, допустимые значения: - 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
3.3.  Площадки (Platforms)
3.3.1  Получение сведений о площадках: GET /platforms
https://api.ord-a.ru/api/v2/platforms
Параметры запроса:
Параметр Тип Обязательность Описание
page число нет Номер страницы
limit число нет Количество записей на странице
sort строка нет Используется при get запросе. Сортировка по столбцу. Допустимые значения: id, -id, name, -name, type, -type, url, -url
Данный метод используется для получения сведений о площадках.
Код ответа Описание
200 ОК Положительный статус запроса
401 Unauthorized Доступ запрещен, невалидный токен
Пример запроса:
curl -X 'GET' \
  'https://api.ord-a.ru/api/v2/platforms/' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'X-CSRF-TOKEN: '
Успешный ответ:
  {
  "data": [
    {
            "id": 326409,
            "name": "Тестовая 1",
            "membership_id": 1,
            "is_partner": false,
            "type": "apps",
            "url": "http://localhost.ru",
            "external_id": null,
            "owner_organization_id": null,
            "deleted_at": null,
            "created_at": "2024-02-21T21:06:39+03:00"
        },
        {
            "id": 326408,
            "name": "Тестовая 2",
            "membership_id": 1,
            "is_partner": false,
            "type": "apps",
            "url": "http://localhost.ru",
            "external_id": null,
            "owner_organization_id": null,
            "deleted_at": null,
            "created_at": "2024-02-21T21:04:16+03:00"
        },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 2,
    "links": [
      {
        "url": null,
        "label": "« Вперед",
        "active": false
      },
      {
        "url": "http://api.ord-a.ru/api/v2/platforms?page=1",
        "label": "1",
        "active": true
      },
    ],
    "path": "http://api.ord-a.ru/api/v2/platforms",
    "per_page": 2,
    "to": 2,
    "total": 2
  }
}
3.3.2 Получение сведений определенной площадки: GET /platforms/{id}
https://api.ord-a.ru/api/v2/platforms/{id}
Данный метод вернет сведения определенной площадки.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор площадки
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Идентификатор площадки не найден
Пример запроса:
curl -X 'GET' \
  'https://api.ord-a.ru/api/v2/platforms/326413' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'X-CSRF-TOKEN: '
Успешный ответ:
{
    "data": {
        "id": 326413,
        "name": "Тестовая измененная",
        "membership_id": 1,
        "is_partner": false,
        "erir_entity": {
            "id": 44374,
            "message": null,
            "status": "В очереди на отправку",
            "status_label": "pending",
            "payload": {
                "platforms": [
                    {
                        "url": "http://localhost",
                        "name": "Тестовая измененная",
                        "type": "site",
                        "report": {
                            "reporterId": 12937,
                            "createdDatetimeInOrd": "2024-02-28 05:31:48.000000",
                            "updatedDatetimeInOrd": "2024-02-28 05:37:35.000000"
                        },
                        "isOwned": false,
                        "platformId": 326413
                    }
                ],
                "organizationId": null
            },
            "created_at": "2024-02-27T18:31:48+03:00",
            "pending_at": "2024-02-27T18:36:48+03:00"
        },
        "type": "site",
        "url": "http://localhost",
        "external_id": "1",
        "owner_organization_id": null,
        "deleted_at": null,
        "created_at": "2024-02-27T18:31:48+03:00"
    }
}
3.3.3 Создание площадки: POST /platforms
https://api.ord-a.ru/api/v2/platforms
Данный метод используется для создания  сведений о площадках.
Код ответа Описание
201 Created Площадка создана
401 Unauthorized Доступ запрещен, невалидный токен
422 Unprocessable Content Некорректный запрос
Пример запроса:
curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/platforms' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "type": "site",
  "name": "Тестовая",
  "url": "http://localhost",
  "external_id": "1"
}'
Успешный ответ:
{
    "data": {
        "id": 326413,
        "name": "Тестовая",
        "membership_id": 1,
        "is_partner": false,
        "type": "site",
        "url": "http://localhost",
        "external_id": "1",
        "owner_organization_id": null,
        "deleted_at": null,
        "created_at": "2024-02-27T18:31:48+03:00"
    }
}
3.3.4  Обновление площадки: PUT /platforms/{id}
https://api.ord-a.ru/api/v2/platforms/{id}
Данный метод используется для обновления сведений о площадках.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор площадки
Код ответа Описание
200 ОК Запрос выполнен удачно
422 Unprocessable Content Некорректный запрос
401 Forbidden Доступ запрещен, невалидный токен
404 Not Found Площадка не найдена
Пример запроса:
curl -X 'PUT' \
  'https://api.ord-a.ru/api/v2/platforms/326413' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "type": "site",
  "name": "Тестовая измененная",
  "url": "http://localhost",
  "external_id": "1"
}'
Успешный ответ:
{
    "data": {
        "id": 326413,
        "name": "Тестовая измененная",
        "membership_id": 1,
        "is_partner": false,
        "erir_entity": {
            "id": 44374,
            "message": null,
            "status": "В очереди на отправку",
            "status_label": "pending",
            "payload": {
                "organizationId": null,
                "platforms": [
                    {
                        "platformId": 326413,
                        "type": "site",
                        "isOwned": false,
                        "name": "Тестовая измененная",
                        "url": "http://localhost",
                        "report": {
                            "reporterId": 12937,
                            "createdDatetimeInOrd": "2024-02-28 05:31:48.000000",
                            "updatedDatetimeInOrd": "2024-02-28 05:37:35.000000"
                        }
                    }
                ]
            },
            "created_at": "2024-02-27T18:31:48+03:00",
            "pending_at": "2024-02-27T18:36:48+03:00"
        },
        "type": "site",
        "url": "http://localhost",
        "external_id": "1",
        "owner_organization_id": null,
        "deleted_at": null,
        "created_at": "2024-02-27T18:31:48+03:00"
    }
}
3.3.5 Удаление площадки: DELETE /platforms/{id}
https://api.ord-a.ru/api/v2/platforms/{id}
Данный метод используется для удаления сведений о площадках.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор площадки
Код ответа Описание
204 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not Found Идентификатор площадки не найден
3.3.6 Восстановление площадки: GET /platforms/{id}/restore
https://api.ord-a.ru/api/v2/platforms/{id}/restore
Данный метод используется для восстановления сведений о площадках.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор площадки
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not Found Идентификатор площадки не найден
3.3.7 Массовое добавление, обновление площадок: GET /platforms/upsert
https://api.ord-a.ru/api/v2/platforms/upsert
Данный метод используется для массового добавления/ обновления площадок.
Пример запроса на создание площадок:
curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/platforms/upsert' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "platforms": [
    {
      "type": "apps",
      "name": "Площадка 1",
      "url": "http://localhost.ru",
      "external_id": "123"
    },
    {
      "type": "is",
      "name": "Площадка 2",
      "url": "http://localhost.ru"
    }
  ]
}'
Успешный ответ:
{
    "data": [
        {
            "id": 645524,
            "external_id": "123"
        },
        {
            "id": 645525,
            "external_id": null
        }
    ],
    "message": "OK"
}
3.3.8 Атрибуты объекта «Платформы» (Platforms):
Параметр Тип Обязательность Описание
id число да Идентификатор контрагента
type строка (255) да

Тип площадки. Возможные значения:

is - Информационная система;
apps - Приложение;
site - Сайт.
name строка (100) да Название сайта (блога) или приложения или иные способы адресации
url строка (2000) Условно обязательно

URL площадки или приложения в сторе.

Необязательно, если тип площадки равен is - Информационная система
Если заполнен, то
Проверка URL:
Проверить протокол http|https
owner _organization_id число Нет Указывается id организации-владельца площадки
external_id строка нет Учетный идентификатор в базе пользователя
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":
{
"message": "",
"status": "В очереди на отправку"
},
...
)
filter[option] строка нет

Параметр для поиска записей сущностей для GET запроса, допустимые значения:
- id;
- name;
- type;
- url;
- external_id;
- status (1, 2, 3, 4, 10)

Пример запроса:

https://api.ord-a.ru/api/v2/platforms/?include=lastEntity&limit=10&page=1&filter[id]=4
3.4 Договоры (Contracts)
3.4.1  Получение сведений о договорах: GET /contracts
https://api.ord-a.ru/api/v2/contracts
Данный метод используется для получения сведений о договорах.
Параметры запроса:
Параметр Тип Обязательность Описание
page число нет Номер страницы
limit число нет Количество записей на странице
sort строка нет Используется при get запросе. Сортировка по столбцу. Допустимые значения: number, -number, date, -date, type, -type, amount, -amount
Код ответа Описание
200 ОК Информация о договорах
401 Unauthorized Доступ запрещен
Успешный ответ:
  {
  "data": [
    {
            "id": 32206,
            "number": "1 от 27.02",
            "is_partner": false,
            "membership_id": 1,
            "type": "contract",
            "client_id": 14168,
            "client": {
                "id": 14168,
                "name": "Измененное имя",
                "is_partner": false,
                "membership_id": 1,
                "type": "ul",
                "is_ors": true,
                "is_rr": false,
                "is_rd": false,
                "inn": "7613946079",
                "mobile_phone": null,
                "epay_number": null,
                "reg_number": null,
                "alternative_inn": null,
                "oksm_number": null,
                "rs_url": "https://local.ru",
                "legal_address": {
                    "city": null,
                    "street": null,
                    "building": null,
                    "postcode": null
                },
                "post_address": {
                    "city": null,
                    "street": null,
                    "building": null,
                    "postcode": null
                },
                "is_agent": false,
                "created_at": "2024-02-26T10:40:48+03:00",
                "deleted_at": null,
                "external_id": "123"
            },
            "contractor_id": 14165,
            "contractor": {
                "id": 14165,
                "name": "массово",
                "is_partner": false,
                "membership_id": 1,
                "type": "fl",
                "is_ors": true,
                "is_rr": false,
                "is_rd": false,
                "inn": "277332520750",
                "mobile_phone": null,
                "epay_number": null,
                "reg_number": null,
                "alternative_inn": "",
                "oksm_number": null,
                "rs_url": "https://my-dev.ord-a.ru",
                "legal_address": {
                    "city": null,
                    "street": null,
                    "building": null,
                    "postcode": null
                },
                "post_address": {
                    "city": null,
                    "street": null,
                    "building": null,
                    "postcode": null
                },
                "is_agent": false,
                "created_at": "2024-02-19T10:41:40+03:00",
                "deleted_at": null,
                "external_id": null
            },
            "is_reg_report": true,
            "is_original_contract": false,
            "date": "2024-02-27",
            "amount": "200",
            "is_vat": true,
            "action_description": null,
            "action": null,
            "subject": "distribution",
            "subject_description": null,
            "parent_contract_id": null,
            "parent_contract": null,
            "agent_acting_for_publisher": false,
            "external_id": "46",
            "created_at": "2024-02-28T08:05:04+03:00",
            "deleted_at": null
        },
        {
            "id": 32205,
            "number": "2 от 27.02",
            "is_partner": false,
            "membership_id": 1,
            "type": "contract",
            "client_id": 14168,
            "client": {
                "id": 14168,
                "name": "Измененное имя",
                "is_partner": false,
                "membership_id": 1,
                "type": "ul",
                "is_ors": true,
                "is_rr": false,
                "is_rd": false,
                "inn": "7613946079",
                "mobile_phone": null,
                "epay_number": null,
                "reg_number": null,
                "alternative_inn": null,
                "oksm_number": null,
                "rs_url": "https://local.ru",
                "legal_address": {
                    "city": null,
                    "street": null,
                    "building": null,
                    "postcode": null
                },
                "post_address": {
                    "city": null,
                    "street": null,
                    "building": null,
                    "postcode": null
                },
                "is_agent": false,
                "created_at": "2024-02-26T10:40:48+03:00",
                "deleted_at": null,
                "external_id": "123"
            },
            "contractor_id": 14165,
            "contractor": {
                "id": 14165,
                "name": "массово",
                "is_partner": false,
                "membership_id": 1,
                "type": "fl",
                "is_ors": true,
                "is_rr": false,
                "is_rd": false,
                "inn": "277332520750",
                "mobile_phone": null,
                "epay_number": null,
                "reg_number": null,
                "alternative_inn": "",
                "oksm_number": null,
                "rs_url": "https://my-dev.ord-a.ru",
                "legal_address": {
                    "city": null,
                    "street": null,
                    "building": null,
                    "postcode": null
                },
                "post_address": {
                    "city": null,
                    "street": null,
                    "building": null,
                    "postcode": null
                },
                "is_agent": false,
                "created_at": "2024-02-19T10:41:40+03:00",
                "deleted_at": null,
                "external_id": null
            },
            "is_reg_report": true,
            "is_original_contract": false,
            "date": "2024-02-27",
            "amount": "200",
            "is_vat": true,
            "action_description": null,
            "action": null,
            "subject": "distribution",
            "subject_description": null,
            "parent_contract_id": null,
            "parent_contract": null,
            "agent_acting_for_publisher": false,
            "external_id": "string",
            "created_at": "2024-02-28T08:04:13+03:00",
            "deleted_at": null
        }
  ],
  "links": {
    "first": "https://api.ord-a.ru/api/v2/contracts?page=1",
    "last": "https://api.ord-a.ru/api/v2/contracts?page=2",
    "prev": null,
    "next": "https://api.ord-a.ru/api/v2/contracts?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/contracts?page=1",
        "label": "1",
        "active": true
      }
    ],
    "path": " https://api.ord-a.ru/api/v2/contracts",
    "per_page": 2,
    "to": 2,
    "total": 2
  }
}
3.4.2  Получение сведений определенного договора: GET /contracts/{id}
https://api.ord-a.ru/api/v2/contracts/{id}
Данный метод используется для получения сведений по конкретному договору.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор площадки
Код ответа Описание
200 ОК Запрос успешно прошел
401 Unauthorized Доступ запрещен
404 Not Found Идентификатор договора не найден
Пример запроса:
curl -X 'GET' \
  'https://api.ord-a.ru/api/v2/contracts/32206' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  TOKEN' \
  -H 'X-CSRF-TOKEN: '
Успешный ответ:
 {
    "data": {
        "id": 32206,
        "number": "1 от 27.02",
        "is_partner": false,
        "membership_id": 1,
        "erir_entity": {
            "id": 44377,
            "message": null,
            "status": "В очереди на отправку",
            "status_label": "pending",
            "payload": {
                "id": 32206,
                "date": "2024-02-27",
                "type": "contract",
                "isVat": true,
                "amount": 200,
                "number": "1 от 27.02",
                "report": {
                    "reporterId": 12937,
                    "createdDatetimeInOrd": "2024-02-28 19:05:04.000000",
                    "updatedDatetimeInOrd": "2024-02-28 19:05:04.000000"
                },
                "clientId": 14168,
                "actionType": null,
                "contractId": null,
                "isRegReport": true,
                "subjectType": "distribution",
                "contractorId": 14165,
                "agentActingForPublisher": false
            },
            "created_at": "2024-02-28T08:05:04+03:00",
            "pending_at": "2024-02-28T08:10:04+03:00"
        },
        "type": "contract",
        "client_id": 14168,
        "client": {
            "id": 14168,
            "name": "Измененное имя",
            "is_partner": false,
            "membership_id": 1,
            "type": "ul",
            "is_ors": true,
            "is_rr": false,
            "is_rd": false,
            "inn": "7613946079",
            "mobile_phone": null,
            "epay_number": null,
            "reg_number": null,
            "alternative_inn": null,
            "oksm_number": null,
            "rs_url": "https://local.ru",
            "legal_address": {
                "city": null,
                "street": null,
                "building": null,
                "postcode": null
            },
            "post_address": {
                "city": null,
                "street": null,
                "building": null,
                "postcode": null
            },
            "is_agent": false,
            "created_at": "2024-02-26T10:40:48+03:00",
            "deleted_at": null,
            "external_id": "123"
        },
        "contractor_id": 14165,
        "contractor": {
            "id": 14165,
            "name": "массово",
            "is_partner": false,
            "membership_id": 1,
            "type": "fl",
            "is_ors": true,
            "is_rr": false,
            "is_rd": false,
            "inn": "277332520750",
            "mobile_phone": null,
            "epay_number": null,
            "reg_number": null,
            "alternative_inn": "",
            "oksm_number": null,
            "rs_url": "https://my-dev.ord-a.ru",
            "legal_address": {
                "city": null,
                "street": null,
                "building": null,
                "postcode": null
            },
            "post_address": {
                "city": null,
                "street": null,
                "building": null,
                "postcode": null
            },
            "is_agent": false,
            "created_at": "2024-02-19T10:41:40+03:00",
            "deleted_at": null,
            "external_id": null
        },
        "is_reg_report": true,
        "is_original_contract": false,
        "date": "2024-02-27",
        "amount": "200",
        "is_vat": true,
        "action_description": null,
        "action": null,
        "subject": "distribution",
        "subject_description": null,
        "parent_contract_id": null,
        "parent_contract": null,
        "agent_acting_for_publisher": false,
        "external_id": "46",
        "created_at": "2024-02-28T08:05:04+03:00",
        "deleted_at": null
    }
}
3.4.3 Создание  договора:  POST /contracts
https://api.ord-a.ru/api/v2/contracts
Данный метод используется для создания сведений о договорах.
Параметры запроса:
Код ответа Описание
201 Created Договор создан
401 Unauthorized Доступ запрещен
422 Unprocessable Content Ошибка во входных данных
Пример запроса:
curl -X 'POST' \
  https://api.ord-a.ru/api/v2/contracts' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "type": "contract",
  "client_id": 14168,
  "contractor_id": 14165,
  "is_reg_report": true,
  "number": "1 от 27.02",
  "date": "2024-02-27",
  "amount": 200,
  "is_vat": true,
  "subject": "distribution",
  "external_id": "46"
}'
Успешный ответ:
{
    "data": {
        "id": 32206,
        "number": "1 от 27.02",
        "is_partner": false,
        "membership_id": 1,
        "type": "contract",
        "client_id": 14168,
        "contractor_id": 14165,
        "is_reg_report": true,
        "date": "2024-02-27",
        "amount": 200,
        "is_vat": true,
        "action_description": null,
        "action": null,
        "subject": "distribution",
        "subject_description": null,
        "parent_contract_id": null,
        "agent_acting_for_publisher": false,
        "external_id": "46",
        "created_at": "2024-02-28T08:05:04+03:00",
        "deleted_at": null
    }
}
3.4.4 Обновление договора: PUT /contracts/{id}
 https://api.ord-a.ru/api/v2/contracts/{id}
Данный метод используется для обновления сведений по конкретному договору.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор площадки
Код ответа Описание
200 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен
404 Not found Идентификатор договора не найден
422 Unprocessable Content Ошибка во входных данных
Пример запроса:
curl -X 'PUT' \
  https://api.ord-a.ru/api/v2/contracts/32206' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "type": "contract",
  "client_id": 14168,
  "contractor_id": 14165,
  "is_reg_report": true,
  "number": "1 от 27.02 Измененный",
  "date": "2024-02-27",
  "amount": 200,
  "is_vat": true,
  "subject": "distribution",
  "external_id": "463"
}'
Успешный ответ:
{
    "data": {
        "id": 32206,
        "number": "1 от 27.02 Измененный",
        "is_partner": false,
        "membership_id": 1,
        "erir_entity": {
            "id": 44377,
            "message": null,
            "status": "В очереди на отправку",
            "status_label": "pending",
            "payload": {
                "id": 32206,
                "type": "contract",
                "clientId": 14168,
                "contractorId": 14165,
                "isRegReport": true,
                "actionType": null,
                "subjectType": "distribution",
                "number": "1 от 27.02 Измененный",
                "date": "2024-02-27",
                "amount": 200,
                "isVat": true,
                "contractId": null,
                "agentActingForPublisher": false,
                "report": {
                    "reporterId": 12937,
                    "createdDatetimeInOrd": "2024-02-28 19:05:04.000000",
                    "updatedDatetimeInOrd": "2024-02-28 22:00:40.000000"
                }
            },
            "created_at": "2024-02-28T08:05:04+03:00",
            "pending_at": "2024-02-28T08:10:04+03:00"
        },
        "type": "contract",
        "client_id": 14168,
        "contractor_id": 14165,
        "is_reg_report": true,
        "date": "2024-02-27",
        "amount": 200,
        "is_vat": true,
        "action_description": null,
        "action": null,
        "subject": "distribution",
        "subject_description": null,
        "parent_contract_id": null,
        "agent_acting_for_publisher": false,
        "external_id": "463",
        "created_at": "2024-02-28T08:05:04+03:00",
        "deleted_at": null
    }
}
3.4.5  Удаление договора: DELETE /contracts/{id}
https://api.ord-a.ru/api/v2/contracts/{id}
Данный метод используется для удаления сведений по конкретному договору.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор площадки
Код ответа Описание
204 ОК Статус успешного запроса
401 Unauthorized Доступ запрещен, невалидный токен
404 Not found Идентификатор креатива не найден
3.4.6  Восстановление договора: GET /contracts/{id}/restore
https://api.ord-a.ru/api/v2/contracts/{id}/restore
Данный метод используется для восстановления сведений по конкретному договору.
Параметры запроса:
Параметр Тип Обязательность Описание
id число да идентификатор площадки
Код ответа Описание
200 ОК Запрос прошел успешно
401 Unauthorized Доступ запрещен
422 Unprocessable Content Некорректный запрос
Пример запроса на обновление договоров:
 curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/contracts/upsert' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "contracts": [
    {
      "id": 32834,
      "type": "contract",
      "client_id": 24520,
      "contractor_id": 25197,
      "is_reg_report": true,
      "number": "1 от 27.02",
      "date": "2024-02-27",
      "amount": 2000,
      "is_vat": false,
      "subject": "distribution",
      "external_id": "3"
    },
    {
      "id": 32820,
      "type": "contract",
      "client_id": 25171,
      "contractor_id": 24534,
      "is_reg_report": true,
      "number": "2 от 27.02",
      "date": "2024-02-27",
      "amount": 100,
      "is_vat": false,
      "subject": "distribution",
      "external_id": "5"
    }
  ]
}'
Успешный ответ:
  {
    "data": [
        {
            "id": 32834,
            "external_id": "3"
        },
        {
            "id": 32820,
            "external_id": "5"
        }
    ],
    "message": "OK"
}
3.4.7  Массовое добавление, обновление договора: POST /contracts/upsert
https://api.ord-a.ru/api/v2/contracts/upsert
Данный метод используется для массового добавления, обновления договоров.
Код ответа Описание
200 ОК Запрос прошел успешно
401 Unauthorized Доступ запрещен
422 Unprocessable Content Некорректный запрос
Пример запроса на обновление договоров:
  curl -X 'POST' \
  'https://api.ord-a.ru/api/v2/contracts/upsert' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-CSRF-TOKEN: ' \
  -d '{
  "contracts": [
    {
      "id": 32834,
      "type": "contract",
      "client_id": 24520,
      "contractor_id": 25197,
      "is_reg_report": true,
      "number": "1 от 27.02",
      "date": "2024-02-27",
      "amount": 2000,
      "is_vat": false,
      "subject": "distribution",
      "external_id": "3"
    },
    {
      "id": 32820,
      "type": "contract",
      "client_id": 25171,
      "contractor_id": 24534,
      "is_reg_report": true,
      "number": "2 от 27.02",
      "date": "2024-02-27",
      "amount": 100,
      "is_vat": false,
      "subject": "distribution",
      "external_id": "5"
    }
  ]
}'
Успешный ответ:
  {
    "data": [
        {
            "id": 32834,
            "external_id": "3"
        },
        {
            "id": 32820,
            "external_id": "5"
        }
    ],
    "message": "OK"
}
3.4.8 Атрибуты объекта «Договоры» (Contracts):
Параметр Тип Обязательность Описание
type строка (255) да

Тип договора. Возможные значения: intermediary-contract - Посреднический договор;
contract - Договор оказания услуг;
additional-agreement - Дополнительное соглашение.

При additional-agreement запрещается указывать parent_сontract_id, в котором client_id и contractor_id отличается от client_id и contractor_id создаваемого доп. соглашения.
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 - Договор на распространение рекламы.
number строка (255) нет Номер договора.
date дата (date) да

Дата договора в формате ГГГГ-мм-дд

1. Дата должна быть не ниже, чем 01.01.1991
2. Дата должна быть меньше или равна текущей дате
amount сумма нет

Сумма договора.

Положительные числа или нулевые
Формат: два знака после запятой, разделитель - точка 22.23
12 цифр до точки, т.е. максимальное число, которое может быть передано = 999 999 999 999
is_vat булево да Признак "с НДС" (Возможные значения: true / false)
action _description строка (128) нет Описание
subject _description строка (128) нет Описание
external_id строка (255) нет Учетный идентификатор в базе пользователя
limit число нет Используется при get запросе. Количество записей при пагинации на странице.
page число нет Используется при get запросе. Номер страницы при пагинации на странице
sort строка нет Используется при get запросе. Сортировка по стоблцу. Допустимые значения: number, -number, date, -date, type, -type, amount, -amount
include Строка нет

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

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

Параметр для поиска записей сущностей для GET запроса, допустимые значения:
- id;
- search;
- type;
- number;
- client;
- date;
- amount;
- parentContract;
- parent_contract_id;
- is_original_contract;
- external_id;
- created_at;
- status (1, 2, 3, 4, 10)

Пример запроса:

https://api.ord-a.ru/api/v2/ contracts /?filter[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)