Помощь
Чат для вопросов по API
Мгновенно ответим на ваши вопросы
api@ati.su
Электронная почта техподдержки
Тикетная система
Оставить заявку на отдел
«Консультанты по интеграции (API)»
api.ati.su - заказы, торги, площадки
Наш телеграм-канал
Код в АТИ:
Выход

Площадки АТИ

«Площадки АТИ» — это сервис для распределения грузов между доверенными перевозчиками и экспедиторами. Создайте Площадку, пригласите на нее контрагентов и размещайте грузы. Никто, кроме участников Площадки не увидит ваш Заказ. Вы можете размещать грузы на одной или сразу на нескольких Площадках. Размещение груза на сайте ATI.SU для всех участников считается размещением на Общей Площадке.

Возможности Площадок

  • Распределение грузов среди доверенных контрагентов.
  • Автоматическое получение данных о перевозчике, водителе и машине без звонков при бронировании и создании Заказа;
  • Проведение Торгов и Сквозных Торгов, а также их гибкая настройка.
  • Разделение партнеров на группы. Создав разные Площадки, вы можете выбирать, какие партнеры увидят груз первыми, а какие — последними.
  • Автоматическое перевыставление на Площадке грузов с Площадки партнера с учетом вашей маржи с помощью механизма Копирования грузов.
  • Анализ эффективности работы с контрагентами с помощью множества отчетов.
  • Копирование грузов из системы ATrucks.
  • Тестирование. Если на Площадке нет участников, никто не увидит грузы размещенные на ней.
  • Поиск новых партнеров. Создайте Открытую Площадку и дайте участникам ATI.SU возможность вступать на нее по вашему разрешению.

Типичный жизненный цикл Площадки

  • Создание и выбор типа Площадки: публичная или закрытая.
  • Настройка прав доступа: кто может видеть грузы, добавлять грузы, видеть список участников площадки.
  • Приглашение контрагентов на Площадку.
  • Если Площадка открытая, вы будете получать заявки на вступление на Площадку.
  • Добавление грузов на Площадку.
  • Автоматическое оповещение участников Площадки о новых грузах.
  • Удаление Площадки, если она больше не нужна.

API Площадок. Используемые термины

Площадка Board — пользователи, имеющие доступ к грузам или машинам Площадки; Участие Participant, Participation — запись об участии пользователя на Площадке. Participant появляется в момент приглашения пользователя на Площадку и имеет Type=invited. Если контрагент принял приглашение, он становится полноправным участником Type=user.

Доступные через API этапы работы с площадками:

Управление площадками

Создание

Фирма может создать до 100 площадок. Контакт фирмы, создавший Площадку, считается ответственным за нее.

Важные параметры Площадки:

  • BoardType на текущий момент принимает только значение loads — Площадки для грузов. В дальнейшем планируется запуск площадок для машин.
  • BoardExchangeDirection — направление обмена грузами на Площадке, определяет права доступа к участникам Площадки по умолчанию. Права можно перенастроить персонально для каждого.
    • Input — грузы публикуются участниками Площадки для её владельца. Участники видят только свои грузы, а владелец Площадки видит всё.
    • Output — владелец Площадки публикует грузы для участников. Участники видят опубликованные грузы, но не могут их добавлять.
    • Exchange — участники Площадки могут добавлять и просматривать грузы.
  • Public.
    • На скрытые Площадки участник может попасть только по приглашению invite.
    • На открытую Площадку участник ATI.SU может подать заявку на вступление Application, которую владелец может одобрить или отклонить.

Создание площадки

 
Создать площадку
post
/v2/boards/public/boards/create
Развернуть все Свернуть все
{...}
all_departments_allowed*: boolean

Площадка доступна всем подразделениям компании. Такую площадку могут видеть все сотрудники, независимо от их подразделения Если передано true, то DepartmentsIds должен быть null или пустым Пример: true

board_exchange_direction*: enum
[input, output, exchange]

Направление обмена информацией на площадке (влияет на права доступа участников по умолчанию)

  • exchange — Обмен грузами/машинами
  • input — Грузы/машины для владельца площадки
  • output - Грузы/машины от владельца площадки
board_type*: enum
[loads, trucks]

Тип содержимого на площадке

  • loads - Площадка с грузами
  • trucks - Площадка с машинами (зарезервировано, в данный момент такая возможность ещё не доступна)
color*: string

Цвет плашки площадки Пример: "#FF00FF"

departments_ids*: [int32]

Перечень подразделений компании, которым доступна площадка. В случае, если передан не пустой перечень значение AllDepartmentsAllowed должно быть false. Ответственный контакт ResponsibleContactId должен состоять (принадлежать) хотя бы одному из указанных подразделений Пример: [100302, 100303]

description*: string

Описание площадки (можно использовать тэги "b", "i", "span", "u", "ul", "li", "br") Пример: "Лучшая площадка из всех созданных"

name_for_users*: string

Публичное имя, видимое участникам площадки (до 50 символов) Пример: "Приходите, покупайте"

private_name*: string

Имя, которое видит только владелец площадки (до 50 символов) Пример: "Покупайте, приходите"

public*: boolean

Открытая площадка или закрытая. На открытую может подать заявку на вступление любой пользователь. На закрытую можно попасть только по приглашению владельца. Пример: true

responsible_contact_id: int32

ID контакта ответственного пользователя Пример: 1

rules*: string

Правила участия, которые требуется принять участникам при вступлении (можно использовать тэги "b", "i", "span", "u", "ul", "li", "br") Пример: "Только красные машины"

}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Данные о площадке
Развернуть все Свернуть все
Пример Модель
{...}
"all_departments_allowed":false,
"available_for_contact":false,
"board_exchange_direction":"input",
"board_type":"loads",
"color":"string",
"created_on":"1970-01-01T00:00:00.000Z",
"departments_ids":[...],
0
],
"id":"string",
"name":"string",
"owner_firm":0,
"updated_on":"1970-01-01T00:00:00.000Z",
"view_only_own":false
}
{...}

Информация о площадке (api v2)

all_departments_allowed*: boolean

Площадка доступна всем подразделениям компании. Такую площадку могут видеть все сотрудники, независимо от их подразделения Пример: true

available_for_contact*: boolean

Площадка доступна для данного контакта Пример: true

board_exchange_direction*: enum
[input, output, exchange]

Направление обмена информацией на площадке (влияет на права доступа участников по умолчанию)

  • exchange — Обмен грузами/машинами
  • input — Грузы/машины для владельца площадки
  • output - Грузы/машины от владельца площадки
board_type*: enum
[loads, trucks]

Тип содержимого на площадке

  • loads - Площадка с грузами
  • trucks - Площадка с машинами (зарезервировано, в данный момент такая возможность ещё не доступна)
color*: string

Цвет площадки Пример: "#FF00FF"

created_on*: date-time

Время создания площадки (timestamp) Пример: 1556201954901

departments_ids*: [int32]

Перечень подразделений компании, которым доступна площадка Пример: [100302, 100303]

id*: string

ID площадки (строка 24 символа) Пример: "507f1f77bcf86cd799439011"

name*: string

Название площадки Пример: "Образцово-показательная площадка"

owner_firm*: int32

Код участника АТИ создавшего площадку Пример: 1111111

updated_on*: date-time

Последнее время изменения площадки (Timestamp) Пример: 1556201954901

view_only_own*: boolean

Участник может видеть только свои грузы/машины Пример: true

}
400 Ошибка валидации или другая
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string",
"details":{...},
"any-key":null
},
"errors_list":[...]
"string"
]
}
{...}
error*: string

Код ошибки

reason*: string

Текст ошибки

errors_list*: [string]

Список ошибок. Поле может отсутствовать в ответе, если для данного типа ошибки оно не предусмотрено

}
Загрузка...
Развернуть все Свернуть все
Загрузка...
 
Создать площадку
Данная версия метода устарела и её поддержка будет прекращена.
Пожалуйста, пользуйтесь актуальной версией API.
post
/v1.0/boards/external/board/create
Развернуть все Свернуть все
{...}
BoardExchangeDirection*: enum
[input, output, exchange]

Тип площадки (влияет на настройки доступа по умолчанию)

BoardType*: enum
[loads, trucks]

Тип содержимого на площадке

Color*: string

Цвет плашки площадки Пример: "#FF00FF"

Description*: string

Описание площадки (можно использовать тэги "b", "i", "span", "u", "ul", "li", "br") Пример: "Лучшая площадка из всех созданных"

NameForUsers*: string

Публичное имя, видимое участникам площадки (до 50 символов) Пример: "Приходите, покупайте"

PrivateName*: string

Имя, которое видит только владелец площадки (до 50 символов) Пример: "Покупайте, приходите"

Public*: boolean

Открытая площадка или закрытая. На открытую может подать заявку на вступление любой пользователь. На закрытую можно попасть только по приглашению владельца. Пример: true

ResponsibleContactId: int32

ID контакта ответственного пользователя Пример: 1

Rules*: string

Правила участия, которые требуется принять участникам при вступлении (можно использовать тэги "b", "i", "span", "u", "ul", "li", "br") Пример: "Только красные машины"

}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Данные о площадке
Развернуть все Свернуть все
Пример Модель
{...}
"BoardExchangeDirection":"input",
"BoardType":"loads",
"Color":"string",
"CreatedOn":"1970-01-01T00:00:00.000Z",
"ID":"string",
"LogoUrl":"string",
"Name":"string",
"OwnerFirm":0,
"UpdatedOn":"1970-01-01T00:00:00.000Z",
"ViewOnlyOwn":false
}
{...}

Информация о площадке

BoardExchangeDirection*: enum
[input, output, exchange]

Тип площадки (влияет на настройки доступа по умолчанию)

BoardType*: enum
[loads, trucks]

Тип содержимого на площадке

Color*: string

Цвет площадки Пример: "#FF00FF"

CreatedOn*: date-time

Время создания площадки (timestamp) Пример: 1556201954901

ID*: string

ID площадки (строка 24 символа) Пример: "507f1f77bcf86cd799439011"

LogoUrl*: string

Относительный путь к логотипу площадки [устарело] Пример: "board/defaultlogo/68/5cc1a5c255b56480407c43e1"

Name*: string

Название площадки Пример: "Образцово-показательная площадка"

OwnerFirm*: int32

Код участника АТИ создавшего площадку Пример: 1111111

UpdatedOn*: date-time

Последнее время изменения площадки (Timestamp) Пример: 1556201954901

ViewOnlyOwn*: boolean

Участник может видеть только свои грузы/машины Пример: true

}
400 Ошибка валидации или другая
Развернуть все Свернуть все
Пример Модель
{...}
"Code":"string",
"Message":"string"
}
{...}

Возвращаемое значение в случае ошибок

Code*: string

В некоторых случаях (валидация) - ID ошибки, например ApplicationAlreadyCreated в случае "вы уже подали заявку на эту площадку"

Message*: string

Человекочитаемый (ну, почти всегда) текст ошибки

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Получение заданной площадки по её ID.

У каждой Площадки есть свой идентификатор. Идентификатор Площадки — строка из 24 символов.

 
Загрузить информацию по площадке
get
/v2/boards/public/boards/{id}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Данные о площадке
Развернуть все Свернуть все
Пример Модель
{...}
"all_departments_allowed":false,
"available_for_contact":false,
"board_exchange_direction":"input",
"board_type":"loads",
"color":"string",
"created_on":"1970-01-01T00:00:00.000Z",
"departments_ids":[...],
0
],
"id":"string",
"name":"string",
"owner_firm":0,
"updated_on":"1970-01-01T00:00:00.000Z",
"view_only_own":false
}
{...}

Информация о площадке (api v2)

all_departments_allowed*: boolean

Площадка доступна всем подразделениям компании. Такую площадку могут видеть все сотрудники, независимо от их подразделения Пример: true

available_for_contact*: boolean

Площадка доступна для данного контакта Пример: true

board_exchange_direction*: enum
[input, output, exchange]

Направление обмена информацией на площадке (влияет на права доступа участников по умолчанию)

  • exchange — Обмен грузами/машинами
  • input — Грузы/машины для владельца площадки
  • output - Грузы/машины от владельца площадки
board_type*: enum
[loads, trucks]

Тип содержимого на площадке

  • loads - Площадка с грузами
  • trucks - Площадка с машинами (зарезервировано, в данный момент такая возможность ещё не доступна)
color*: string

Цвет площадки Пример: "#FF00FF"

created_on*: date-time

Время создания площадки (timestamp) Пример: 1556201954901

departments_ids*: [int32]

Перечень подразделений компании, которым доступна площадка Пример: [100302, 100303]

id*: string

ID площадки (строка 24 символа) Пример: "507f1f77bcf86cd799439011"

name*: string

Название площадки Пример: "Образцово-показательная площадка"

owner_firm*: int32

Код участника АТИ создавшего площадку Пример: 1111111

updated_on*: date-time

Последнее время изменения площадки (Timestamp) Пример: 1556201954901

view_only_own*: boolean

Участник может видеть только свои грузы/машины Пример: true

}
400 Ошибка валидации или другая
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string",
"details":{...},
"any-key":null
},
"errors_list":[...]
"string"
]
}
{...}
error*: string

Код ошибки

reason*: string

Текст ошибки

errors_list*: [string]

Список ошибок. Поле может отсутствовать в ответе, если для данного типа ошибки оно не предусмотрено

}
Загрузка...
Развернуть все Свернуть все
Загрузка...
 
Загрузить информацию по площадке
Данная версия метода устарела и её поддержка будет прекращена.
Пожалуйста, пользуйтесь актуальной версией API.
get
/v1.0/boards/external/board/{id}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Данные о площадке
Развернуть все Свернуть все
Пример Модель
{...}
"BoardExchangeDirection":"input",
"BoardType":"loads",
"Color":"string",
"CreatedOn":"1970-01-01T00:00:00.000Z",
"ID":"string",
"LogoUrl":"string",
"Name":"string",
"OwnerFirm":0,
"UpdatedOn":"1970-01-01T00:00:00.000Z",
"ViewOnlyOwn":false
}
{...}

Информация о площадке

BoardExchangeDirection*: enum
[input, output, exchange]

Тип площадки (влияет на настройки доступа по умолчанию)

BoardType*: enum
[loads, trucks]

Тип содержимого на площадке

Color*: string

Цвет площадки Пример: "#FF00FF"

CreatedOn*: date-time

Время создания площадки (timestamp) Пример: 1556201954901

ID*: string

ID площадки (строка 24 символа) Пример: "507f1f77bcf86cd799439011"

LogoUrl*: string

Относительный путь к логотипу площадки [устарело] Пример: "board/defaultlogo/68/5cc1a5c255b56480407c43e1"

Name*: string

Название площадки Пример: "Образцово-показательная площадка"

OwnerFirm*: int32

Код участника АТИ создавшего площадку Пример: 1111111

UpdatedOn*: date-time

Последнее время изменения площадки (Timestamp) Пример: 1556201954901

ViewOnlyOwn*: boolean

Участник может видеть только свои грузы/машины Пример: true

}
400 Ошибка валидации или другая
Развернуть все Свернуть все
Пример Модель
{...}
"Code":"string",
"Message":"string"
}
{...}

Возвращаемое значение в случае ошибок

Code*: string

В некоторых случаях (валидация) - ID ошибки, например ApplicationAlreadyCreated в случае "вы уже подали заявку на эту площадку"

Message*: string

Человекочитаемый (ну, почти всегда) текст ошибки

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Получение списка всех актуальных площадок

Данный метод возвращает все Площадки: созданные вами и те, где вы являетесь участником.

 
Список площадок, на которые пользователь может добавлять грузы или машины
get
/v2/boards/public/boards/list
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Список площадок с их данными
Развернуть все Свернуть все
Пример Модель
[...]
{...}
"all_departments_allowed":false,
"available_for_contact":false,
"board_exchange_direction":"input",
"board_type":"loads",
"color":"string",
"created_on":"1970-01-01T00:00:00.000Z",
"departments_ids":[...],
0
],
"id":"string",
"name":"string",
"owner_firm":0,
"updated_on":"1970-01-01T00:00:00.000Z",
"view_only_own":false,
"auctions_count":0,
"can_add":false,
"can_view":false,
"content_count":0,
"participants_count":0,
"tenders_count":0
}
]
[{...}]
all_departments_allowed*: boolean

Площадка доступна всем подразделениям компании. Такую площадку могут видеть все сотрудники, независимо от их подразделения Пример: true

available_for_contact*: boolean

Площадка доступна для данного контакта Пример: true

board_exchange_direction*: enum
[input, output, exchange]

Направление обмена информацией на площадке (влияет на права доступа участников по умолчанию)

  • exchange — Обмен грузами/машинами
  • input — Грузы/машины для владельца площадки
  • output - Грузы/машины от владельца площадки
board_type*: enum
[loads, trucks]

Тип содержимого на площадке

  • loads - Площадка с грузами
  • trucks - Площадка с машинами (зарезервировано, в данный момент такая возможность ещё не доступна)
color*: string

Цвет площадки Пример: "#FF00FF"

created_on*: date-time

Время создания площадки (timestamp) Пример: 1556201954901

departments_ids*: [int32]

Перечень подразделений компании, которым доступна площадка Пример: [100302, 100303]

id*: string

ID площадки (строка 24 символа) Пример: "507f1f77bcf86cd799439011"

name*: string

Название площадки Пример: "Образцово-показательная площадка"

owner_firm*: int32

Код участника АТИ создавшего площадку Пример: 1111111

updated_on*: date-time

Последнее время изменения площадки (Timestamp) Пример: 1556201954901

view_only_own*: boolean

Участник может видеть только свои грузы/машины Пример: true

auctions_count: int32

Количество содержимого (грузов) с аукционами на площадке Пример: 5

can_add*: boolean

Есть ли право добавлять грузы Пример: false

can_view*: boolean

Есть ли право просматривать грузы Пример: true

content_count: int64

Количество грузов или машин на площадке Пример: 34

participants_count: int64

Количество участников площадки Пример: 15

tenders_count: int32

Количество тендеров на площадке Пример: 2

}]
Загрузка...
Развернуть все Свернуть все
Загрузка...
 
Список площадок, на которые пользователь может добавлять грузы или машины
Данная версия метода устарела и её поддержка будет прекращена.
Пожалуйста, пользуйтесь актуальной версией API.
get
/v1.0/boards/external/board/list
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Список площадок с их данными
Развернуть все Свернуть все
Пример Модель
[...]
{...}
"BoardExchangeDirection":"input",
"BoardType":"loads",
"Color":"string",
"CreatedOn":"1970-01-01T00:00:00.000Z",
"ID":"string",
"LogoUrl":"string",
"Name":"string",
"OwnerFirm":0,
"UpdatedOn":"1970-01-01T00:00:00.000Z",
"ViewOnlyOwn":false,
"AuctionsCount":0,
"CanAdd":false,
"CanView":false,
"ContentCount":0,
"ParticipantsCount":0,
"TendersCount":0
}
]
[{...}]
BoardExchangeDirection*: enum
[input, output, exchange]

Тип площадки (влияет на настройки доступа по умолчанию)

BoardType*: enum
[loads, trucks]

Тип содержимого на площадке

Color*: string

Цвет площадки Пример: "#FF00FF"

CreatedOn*: date-time

Время создания площадки (timestamp) Пример: 1556201954901

ID*: string

ID площадки (строка 24 символа) Пример: "507f1f77bcf86cd799439011"

LogoUrl*: string

Относительный путь к логотипу площадки [устарело] Пример: "board/defaultlogo/68/5cc1a5c255b56480407c43e1"

Name*: string

Название площадки Пример: "Образцово-показательная площадка"

OwnerFirm*: int32

Код участника АТИ создавшего площадку Пример: 1111111

UpdatedOn*: date-time

Последнее время изменения площадки (Timestamp) Пример: 1556201954901

ViewOnlyOwn*: boolean

Участник может видеть только свои грузы/машины Пример: true

AuctionsCount: int32

Количество содержимого (грузов) с аукционами на площадке Пример: 5

CanAdd*: boolean

Есть ли право добавлять грузы Пример: false

CanView*: boolean

Есть ли право просматривать грузы Пример: true

ContentCount: int64

Количество грузов или машин на площадке Пример: 34

ParticipantsCount: int64

Количество участников площадки Пример: 15

TendersCount: int32

Количество тендеров на площадке Пример: 2

}]
Загрузка...
Развернуть все Свернуть все
Загрузка...

Получение площадок для добавления груза canAdd.

Этот метод предоставит список Площадок, на которые вы можете добавлять грузы.

 
Список площадок, на которые пользователь может добавлять грузы или машины
get
/v2/boards/public/boards/canAdd
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Список площадок с их данными
Развернуть все Свернуть все
Пример Модель
[...]
{...}
"all_departments_allowed":false,
"available_for_contact":false,
"board_exchange_direction":"input",
"board_type":"loads",
"color":"string",
"created_on":"1970-01-01T00:00:00.000Z",
"departments_ids":[...],
0
],
"id":"string",
"name":"string",
"owner_firm":0,
"updated_on":"1970-01-01T00:00:00.000Z",
"view_only_own":false
}
]
[{...}]

Информация о площадке (api v2)

all_departments_allowed*: boolean

Площадка доступна всем подразделениям компании. Такую площадку могут видеть все сотрудники, независимо от их подразделения Пример: true

available_for_contact*: boolean

Площадка доступна для данного контакта Пример: true

board_exchange_direction*: enum
[input, output, exchange]

Направление обмена информацией на площадке (влияет на права доступа участников по умолчанию)

  • exchange — Обмен грузами/машинами
  • input — Грузы/машины для владельца площадки
  • output - Грузы/машины от владельца площадки
board_type*: enum
[loads, trucks]

Тип содержимого на площадке

  • loads - Площадка с грузами
  • trucks - Площадка с машинами (зарезервировано, в данный момент такая возможность ещё не доступна)
color*: string

Цвет площадки Пример: "#FF00FF"

created_on*: date-time

Время создания площадки (timestamp) Пример: 1556201954901

departments_ids*: [int32]

Перечень подразделений компании, которым доступна площадка Пример: [100302, 100303]

id*: string

ID площадки (строка 24 символа) Пример: "507f1f77bcf86cd799439011"

name*: string

Название площадки Пример: "Образцово-показательная площадка"

owner_firm*: int32

Код участника АТИ создавшего площадку Пример: 1111111

updated_on*: date-time

Последнее время изменения площадки (Timestamp) Пример: 1556201954901

view_only_own*: boolean

Участник может видеть только свои грузы/машины Пример: true

}]
Загрузка...
Развернуть все Свернуть все
Загрузка...
 
Список площадок, на которые пользователь может добавлять грузы или машины
Данная версия метода устарела и её поддержка будет прекращена.
Пожалуйста, пользуйтесь актуальной версией API.
get
/v1.0/boards/external/board/canAdd
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Список площадок с их данными
Развернуть все Свернуть все
Пример Модель
[...]
{...}
"BoardExchangeDirection":"input",
"BoardType":"loads",
"Color":"string",
"CreatedOn":"1970-01-01T00:00:00.000Z",
"ID":"string",
"LogoUrl":"string",
"Name":"string",
"OwnerFirm":0,
"UpdatedOn":"1970-01-01T00:00:00.000Z",
"ViewOnlyOwn":false
}
]
[{...}]

Информация о площадке

BoardExchangeDirection*: enum
[input, output, exchange]

Тип площадки (влияет на настройки доступа по умолчанию)

BoardType*: enum
[loads, trucks]

Тип содержимого на площадке

Color*: string

Цвет площадки Пример: "#FF00FF"

CreatedOn*: date-time

Время создания площадки (timestamp) Пример: 1556201954901

ID*: string

ID площадки (строка 24 символа) Пример: "507f1f77bcf86cd799439011"

LogoUrl*: string

Относительный путь к логотипу площадки [устарело] Пример: "board/defaultlogo/68/5cc1a5c255b56480407c43e1"

Name*: string

Название площадки Пример: "Образцово-показательная площадка"

OwnerFirm*: int32

Код участника АТИ создавшего площадку Пример: 1111111

UpdatedOn*: date-time

Последнее время изменения площадки (Timestamp) Пример: 1556201954901

ViewOnlyOwn*: boolean

Участник может видеть только свои грузы/машины Пример: true

}]
Загрузка...
Развернуть все Свернуть все
Загрузка...

Получение площадок для поиска груза canView.

Этот метод позволяет узнать, на каких Площадках вы можете видеть грузы.

 
Получает список площадок, на которых участник может видеть грузы/машины
get
/v2/boards/public/boards/canView
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Список площадок с их данными
Развернуть все Свернуть все
Пример Модель
[...]
{...}
"all_departments_allowed":false,
"available_for_contact":false,
"board_exchange_direction":"input",
"board_type":"loads",
"color":"string",
"created_on":"1970-01-01T00:00:00.000Z",
"departments_ids":[...],
0
],
"id":"string",
"name":"string",
"owner_firm":0,
"updated_on":"1970-01-01T00:00:00.000Z",
"view_only_own":false
}
]
[{...}]

Информация о площадке (api v2)

all_departments_allowed*: boolean

Площадка доступна всем подразделениям компании. Такую площадку могут видеть все сотрудники, независимо от их подразделения Пример: true

available_for_contact*: boolean

Площадка доступна для данного контакта Пример: true

board_exchange_direction*: enum
[input, output, exchange]

Направление обмена информацией на площадке (влияет на права доступа участников по умолчанию)

  • exchange — Обмен грузами/машинами
  • input — Грузы/машины для владельца площадки
  • output - Грузы/машины от владельца площадки
board_type*: enum
[loads, trucks]

Тип содержимого на площадке

  • loads - Площадка с грузами
  • trucks - Площадка с машинами (зарезервировано, в данный момент такая возможность ещё не доступна)
color*: string

Цвет площадки Пример: "#FF00FF"

created_on*: date-time

Время создания площадки (timestamp) Пример: 1556201954901

departments_ids*: [int32]

Перечень подразделений компании, которым доступна площадка Пример: [100302, 100303]

id*: string

ID площадки (строка 24 символа) Пример: "507f1f77bcf86cd799439011"

name*: string

Название площадки Пример: "Образцово-показательная площадка"

owner_firm*: int32

Код участника АТИ создавшего площадку Пример: 1111111

updated_on*: date-time

Последнее время изменения площадки (Timestamp) Пример: 1556201954901

view_only_own*: boolean

Участник может видеть только свои грузы/машины Пример: true

}]
Загрузка...
Развернуть все Свернуть все
Загрузка...
 
Получает список площадок, на которых участник может видеть грузы/машины
get
/v1.0/boards/external/board/canView
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Список площадок с их данными
Развернуть все Свернуть все
Пример Модель
[...]
{...}
"BoardExchangeDirection":"input",
"BoardType":"loads",
"Color":"string",
"CreatedOn":"1970-01-01T00:00:00.000Z",
"ID":"string",
"LogoUrl":"string",
"Name":"string",
"OwnerFirm":0,
"UpdatedOn":"1970-01-01T00:00:00.000Z",
"ViewOnlyOwn":false
}
]
[{...}]

Информация о площадке

BoardExchangeDirection*: enum
[input, output, exchange]

Тип площадки (влияет на настройки доступа по умолчанию)

BoardType*: enum
[loads, trucks]

Тип содержимого на площадке

Color*: string

Цвет площадки Пример: "#FF00FF"

CreatedOn*: date-time

Время создания площадки (timestamp) Пример: 1556201954901

ID*: string

ID площадки (строка 24 символа) Пример: "507f1f77bcf86cd799439011"

LogoUrl*: string

Относительный путь к логотипу площадки [устарело] Пример: "board/defaultlogo/68/5cc1a5c255b56480407c43e1"

Name*: string

Название площадки Пример: "Образцово-показательная площадка"

OwnerFirm*: int32

Код участника АТИ создавшего площадку Пример: 1111111

UpdatedOn*: date-time

Последнее время изменения площадки (Timestamp) Пример: 1556201954901

ViewOnlyOwn*: boolean

Участник может видеть только свои грузы/машины Пример: true

}]
Загрузка...
Развернуть все Свернуть все
Загрузка...

Получение списка ID моих площадок.

Этот метод покажет ID всех Площадок, которые были созданы вами.

 
Получает список ID площадок, принадлежащих участнику АТИ.
get
/v2/boards/public/boards/my
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Список ID площадок
Развернуть все Свернуть все
Пример Модель
[...]
"string"
]
[string]
Загрузка...
Развернуть все Свернуть все
Загрузка...
 
Получает список ID площадок, принадлежащих участнику АТИ.
Данная версия метода устарела и её поддержка будет прекращена.
Пожалуйста, пользуйтесь актуальной версией API.
get
/v1.0/boards/external/board/my
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Список ID площадок
Развернуть все Свернуть все
Пример Модель
[...]
"string"
]
[string]
Загрузка...
Развернуть все Свернуть все
Загрузка...

Получение списка ID Площадок с вашим участием.

Этот метод покажет ID всех Площадок, на которых вы состоите.

 
Получает список ID площадок, на которых состоит участник АТИ.
get
/v2/boards/public/boards/participating
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Список ID площадок
Развернуть все Свернуть все
Пример Модель
[...]
"string"
]
[string]
Загрузка...
Развернуть все Свернуть все
Загрузка...
 
Получает список ID площадок, на которых состоит участник АТИ.
Данная версия метода устарела и её поддержка будет прекращена.
Пожалуйста, пользуйтесь актуальной версией API.
get
/v1.0/boards/external/board/participating
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Список ID площадок
Развернуть все Свернуть все
Пример Модель
[...]
"string"
]
[string]
Загрузка...
Развернуть все Свернуть все
Загрузка...

Как пригласить пользователя на вашу Площадку

Чтобы участник ATI.SU смог пользоваться вашей Площадкой, вышлите ему приглашение — invite. Приглашение — это один из типов участия на Площадке, запись с типом Type=invited. Принятие приглашения пользователем просто меняет тип участия на Type=user. ID приглашения после принятия приглашения остаётся неизменным и работает как ID участника.

Пригласить участника АТИ на Площадку.

 
Пригласить участника АТИ на площадку (создание участника площадки с типом Invited)
post
/v2/boards/public/participants/invite
Развернуть все Свернуть все
{...}
ati_id*: string

код участника в АТИ

board_id*: string

ID площадки

contact_id: int32

ID контакта

}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 ID приглашения
Развернуть все Свернуть все
Пример Модель
"string"
string
400 Ошибка валидации
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string",
"details":{...},
"any-key":null
},
"errors_list":[...]
"string"
]
}
{...}
error*: string

Код ошибки

reason*: string

Текст ошибки

errors_list*: [string]

Список ошибок. Поле может отсутствовать в ответе, если для данного типа ошибки оно не предусмотрено

}
Загрузка...
Развернуть все Свернуть все
Загрузка...
 
Пригласить участника АТИ на площадку
Данная версия метода устарела и её поддержка будет прекращена.
Пожалуйста, пользуйтесь актуальной версией API.
post
/v1.0/boards/external/invite
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 ID приглашения
Развернуть все Свернуть все
Пример Модель
"string"
string
400 Ошибка валидации или другая
Развернуть все Свернуть все
Пример Модель
{...}
"Code":"string",
"Message":"string"
}
{...}

Возвращаемое значение в случае ошибок

Code*: string

В некоторых случаях (валидация) - ID ошибки, например ApplicationAlreadyCreated в случае "вы уже подали заявку на эту площадку"

Message*: string

Человекочитаемый (ну, почти всегда) текст ошибки

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Как посмотреть, кто приглашает вас на свои Площадки.

Принять или отклонить приглашение можно с помощью метода модификации участия.

 
Получает список приглашений
get
/v2/boards/public/participants/invite/my
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Список приглашений
Развернуть все Свернуть все
Пример Модель
[...]
{...}
"board_info":{...},
"all_departments_allowed":false,
"available_for_contact":false,
"board_exchange_direction":"input",
"board_type":"loads",
"color":"string",
"created_on":"1970-01-01T00:00:00.000Z",
"departments_ids":[...],
0
],
"id":"string",
"name":"string",
"owner_firm":0,
"updated_on":"1970-01-01T00:00:00.000Z",
"view_only_own":false
},
"participant":{...}
"ati_id":"string",
"board_id":"string",
"can_add":false,
"created_on":"1970-01-01T00:00:00.000Z",
"responsible_contact_id":0,
"sender_ati_id":"string",
"type":"user",
"type_changed":"1970-01-01T00:00:00.000Z",
"view_content":false,
"view_participants":false
}
}
]
[{...}]

Информация о приглашении на площадку

}]
400 Ошибка валидации или другая
Развернуть все Свернуть все
Пример Модель
{...}
"Code":"string",
"Message":"string"
}
{...}

Возвращаемое значение в случае ошибок

Code*: string

В некоторых случаях (валидация) - ID ошибки, например ApplicationAlreadyCreated в случае "вы уже подали заявку на эту площадку"

Message*: string

Человекочитаемый текст ошибки

}
Загрузка...
Развернуть все Свернуть все
Загрузка...
 
Получает список приглашений
Данная версия метода устарела и её поддержка будет прекращена.
Пожалуйста, пользуйтесь актуальной версией API.
get
/v1.0/boards/external/invite/my
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Список приглашений
Развернуть все Свернуть все
Пример Модель
[...]
{...}
"BoardInfo":{...},
"BoardExchangeDirection":"input",
"BoardType":"loads",
"Color":"string",
"CreatedOn":"1970-01-01T00:00:00.000Z",
"ID":"string",
"LogoUrl":"string",
"Name":"string",
"OwnerFirm":0,
"UpdatedOn":"1970-01-01T00:00:00.000Z",
"ViewOnlyOwn":false
},
"Participant":{...}
"AtiID":"string",
"BoardID":"string",
"CanAdd":false,
"CreatedOn":"1970-01-01T00:00:00.000Z",
"ResponsibleContactId":0,
"SenderAtiID":"string",
"Type":"user",
"TypeChanged":"1970-01-01T00:00:00.000Z",
"ViewContent":false,
"ViewParticipants":false
}
}
]
[{...}]

Информация о приглашении на площадку

}]
400 Ошибка валидации или другая
Развернуть все Свернуть все
Пример Модель
{...}
"Code":"string",
"Message":"string"
}
{...}

Возвращаемое значение в случае ошибок

Code*: string

В некоторых случаях (валидация) - ID ошибки, например ApplicationAlreadyCreated в случае "вы уже подали заявку на эту площадку"

Message*: string

Человекочитаемый (ну, почти всегда) текст ошибки

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Типы участия пользователей на Площадках

Каждая связь фирмы и Площадки является участием. У участия могут быть разные типы: владелец Площадки, приглашенный, участник. Некоторые типы можно поменять на другие, если это разрешено логикой приложения.

Тип Описание Заметка
User Пользователь Полноценный пользователь Площадки
Revoked Отозвано Выславший приглашение отозвал его
Rejected Отказ Приглашённый отказался от вступления на Площадку
Invited Приглашение Пользователь приглашён на площадку, но ещё не принял приглашение
InvitedViewed Приглашение просмотрено Один из контактов приглашённой фирмы просмотрел приглашение, но не ответил
RejectedViewed Отказ просмотрен Один из контактов приглашающей фирмы открывал страницу, на которой виден отказ от участия
Left Участник покинул площадку Служебный статус
Deleted Участник удалён с площадки Служебный статус
Owner Владелец Площадки

Получение списка участников Площадки.

ID — это идентификатор Площадки, а параметры offset и limit используются, чтобы разбить список на страницы. Эти два параметра можно не указывать, тогда все участники Площадки будут отображены без разбивки на страницы.

 
Получить список участников площадки
post
/v2/boards/public/participants/list
Развернуть все Свернуть все
{...}
board_ids*: [string]

Отфильтровать по площадкам

limit: int32

Ограничение количества для постраничных запросов

offset: int32

Отступ для постраничных запросов

only_my*: boolean

Показывать только свои участия

type: enum
[user, tempRevoked, revoked, tempDeleted, tempRejected, rejected, revokedViewed, invited, invitedViewed, rejectedViewed, left, deleted, firmDeleted, owner]

Тип участия пользователя на площадке

}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Список участий
Развернуть все Свернуть все
Пример Модель
{...}
"result":[...],
{...}
"ati_id":"string",
"board_id":"string",
"can_add":false,
"created_on":"1970-01-01T00:00:00.000Z",
"responsible_contact_id":0,
"sender_ati_id":"string",
"type":"user",
"type_changed":"1970-01-01T00:00:00.000Z",
"view_content":false,
"view_participants":false
}
],
"total_count":0
}
{...}

Страница с результатами поиска

total_count*: int64

Всего результатов, количество

}
400 Ошибка валидации или другая
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string",
"details":{...},
"any-key":null
},
"errors_list":[...]
"string"
]
}
{...}
error*: string

Код ошибки

reason*: string

Текст ошибки

errors_list*: [string]

Список ошибок. Поле может отсутствовать в ответе, если для данного типа ошибки оно не предусмотрено

}
Загрузка...
Развернуть все Свернуть все
Загрузка...
 
Получить список участников площадки
Данная версия метода устарела и её поддержка будет прекращена.
Пожалуйста, пользуйтесь актуальной версией API.
get
/v1.0/boards/external/participants/board/{id}/{offset}/{limit}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 Список участников площадки
Развернуть все Свернуть все
Пример Модель
[...]
{...}
"Available":{...},
"Reason":"string",
"Value":false
},
"Result":[...],
{...}
"AtiID":"string",
"BoardID":"string",
"CanAdd":false,
"CreatedOn":"1970-01-01T00:00:00.000Z",
"ResponsibleContactId":0,
"SenderAtiID":"string",
"Type":"user",
"TypeChanged":"1970-01-01T00:00:00.000Z",
"ViewContent":false,
"ViewParticipants":false
}
],
"TotalCount":0,
"UserCount":0
}
]
[{...}]

Результаты поиска участников

TotalCount: int32
UserCount: int32
}]
400 Ошибка валидации или другая
Развернуть все Свернуть все
Пример Модель
{...}
"Code":"string",
"Message":"string"
}
{...}

Возвращаемое значение в случае ошибок

Code*: string

В некоторых случаях (валидация) - ID ошибки, например ApplicationAlreadyCreated в случае "вы уже подали заявку на эту площадку"

Message*: string

Человекочитаемый (ну, почти всегда) текст ошибки

}
Загрузка...
Развернуть все Свернуть все
Загрузка...

Модификация участника Площадки.

С помощью этого метода приглашенный участник может принять приглашение, а владелец Площадки может изменить права доступа участника. Например, удалить с Площадки.

Обязательные параметры — код АТИ участника и ID Площадки. Все остальные параметры — опциональны, и будут применены только если у пользователя, отправившего запрос, есть права на данное изменение.

  • Type меняет тип участия.
  • CanAdd дает участнику право добавлять грузы на Площадку.
  • ViewParticipants дает право видеть других участников.
  • ViewContent дает право видеть грузы других участников Площадки.
 
Поменять параметры участника площадки
post
/v2/boards/public/participants/modify
Развернуть все Свернуть все
{...}

Описание требуемых изменений участника площадки

ati_id*: string

ID участника ATI

board_id*: string

ID площадки

can_add: boolean

Может ли добавлять грузы/машины на площадку

type: enum
[user, tempRevoked, revoked, tempDeleted, tempRejected, rejected, revokedViewed, invited, invitedViewed, rejectedViewed, left, deleted, firmDeleted, owner]

Тип участия пользователя на площадке

view_content: boolean

Может ли видеть грузы/машины площадки

view_participants: boolean

Может ли видеть других участников площадки

}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 успешно/не успешно
Развернуть все Свернуть все
Пример Модель
boolean
400 Ошибка валидации или другая
Развернуть все Свернуть все
Пример Модель
{...}
"error":"string",
"reason":"string",
"details":{...},
"any-key":null
},
"errors_list":[...]
"string"
]
}
{...}
error*: string

Код ошибки

reason*: string

Текст ошибки

errors_list*: [string]

Список ошибок. Поле может отсутствовать в ответе, если для данного типа ошибки оно не предусмотрено

}
Загрузка...
Развернуть все Свернуть все
Загрузка...
 
Меняет параметры участника площадки
Данная версия метода устарела и её поддержка будет прекращена.
Пожалуйста, пользуйтесь актуальной версией API.
post
/v1.0/boards/external/participants/modify
Развернуть все Свернуть все
{...}

Описание требуемых изменений участника площадки

AtiID*: string

ID участника ATI

BoardID*: string

ID площадки

CanAdd: boolean

Может ли добавлять грузы/машины на площадку

Type: enum
[user, tempRevoked, revoked, tempDeleted, tempRejected, rejected, revokedViewed, invited, invitedViewed, rejectedViewed, left, deleted, firmDeleted, owner]

Тип участия пользователя на площадке

ViewContent: boolean

Может ли видеть грузы/машины площадки

ViewParticipants: boolean

Может ли видеть других участников площадки

}
CURL 1C
CURL
Копировать

                
1C
Копировать

                
Пример ответа Ответ
200 успешно/не успешно
Развернуть все Свернуть все
Пример Модель
boolean
400 Ошибка валидации или другая
Развернуть все Свернуть все
Пример Модель
{...}
"Code":"string",
"Message":"string"
}
{...}

Возвращаемое значение в случае ошибок

Code*: string

В некоторых случаях (валидация) - ID ошибки, например ApplicationAlreadyCreated в случае "вы уже подали заявку на эту площадку"

Message*: string

Человекочитаемый (ну, почти всегда) текст ошибки

}
Загрузка...
Развернуть все Свернуть все
Загрузка...