Площадки ATI.SU

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

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

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

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

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

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

Площадка Board — пользователи, имеющие доступ к грузам или машинам Площадки; Участие Participant, Participation — запись об участии пользователя на Площадке. В списке приглашений 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]

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

Выбор неверного направления из допустимых значений создаст площадку с неподходящими правами, а не вызовет отказ. Неизвестное направление вызывает ошибку. Числа и строки с числовым значением принимаются для совместимости.

• input — Грузы и машины от участников к владельцу площадки
• output — Грузы и машины от владельца площадки к участникам
• exchange — Обмен грузами и машинами между всеми участниками

board_requirements:{...}

Опциональный список требований к площадке.
Поддерживаемые требования:
- требуемые от участников файлы и сканы RequirementDocumentTypeDto
Пример: <br>[{<br> "type_id": null,<br> "type_name": "Сертификат партнера нашей компании",<br> "is_requirable": true<br>}]<br>

requirement_document_types:[{...}]

Список документов, требуемых к загрузке участниками площадки

base_type_id: enum

[inn, registrationCertificate, constituentDocuments, requisites, priceList, commercialOffer]

Базовый тип документа, который площадка запрашивает у участников. Передаётся строкой в camelCase в поле base_type_id.

Для базового типа не задавайте custom_type_name. Для собственного типа оставьте base_type_id пустым и задайте custom_type_name. Неизвестный базовый тип вызывает ошибку валидации. Числа и строки с числовым значением принимаются для совместимости.

• inn — Свидетельство о постановке на налоговый учет (ИНН)
• registrationCertificate — Свидетельство о регистрации юрлица или ИП
• constituentDocuments — Учредительные документы
• requisites — Реквизиты
• priceList — Прайс-лист
• commercialOffer — Коммерческое предложение

custom_type_name: string

Пользовательское имя типа документа, только для пользовательских типов

is_requirable*: boolean

Данный тип файла обязателен к предоставлению

}]

rules: string

Правила площадки (можно использовать html-тэги "b", "i", "span", "u", "ul", "li", "br")

}

board_type*: enum

[loads, trucks]

Тип содержимого площадки. Передаётся строкой в camelCase; тот же тип возвращается в board_type списка площадок.

Для создания площадки используйте loads. Другой тип приведёт к ошибке: площадки с машинами пока не поддерживаются. Числа и строки с числовым значением продолжают приниматься для совместимости; используйте строковое имя.

• loads — Площадка с грузами
• trucks — Площадка с машинами (зарезервировано, создание пока не поддерживается)

color: string

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

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

subscribe_to_notifications: boolean

Подписывать на уведомления новых участников. Пример: true

}

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

CURL

curl 'https://api.ati.su/v2/boards/public/boards/create' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"all_departments_allowed":false,"board_exchange_direction":"input","board_requirements":{"requirement_document_types":[{"base_type_id":"inn","custom_type_name":"string","is_requirable":false}],"rules":"string"},"board_type":"loads","color":"string","departments_ids":[0],"description":"string","name_for_users":"string","private_name":"string","public":false,"responsible_contact_id":0,"subscribe_to_notifications":false}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/v2/boards/public/boards/create", "{""all_departments_allowed"":false,""board_exchange_direction"":""input"",""board_requirements"":{""requirement_document_types"":[{""base_type_id"":""inn"",""custom_type_name"":""string"",""is_requirable"":false}],""rules"":""string""},""board_type"":""loads"",""color"":""string"",""departments_ids"":[0],""description"":""string"",""name_for_users"":""string"",""private_name"":""string"",""public"":false,""responsible_contact_id"":0,""subscribe_to_notifications"":false}");

Ответ

200 Данные о площадке

Модель

{...}

all_departments_allowed*: boolean

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

available_for_contact*: boolean

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

board_exchange_direction*: enum

[input, output, exchange]

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

Выбор неверного направления из допустимых значений создаст площадку с неподходящими правами, а не вызовет отказ. Неизвестное направление вызывает ошибку. Числа и строки с числовым значением принимаются для совместимости.

• input — Грузы и машины от участников к владельцу площадки
• output — Грузы и машины от владельца площадки к участникам
• exchange — Обмен грузами и машинами между всеми участниками

board_type*: enum

[loads, trucks]

Тип содержимого площадки. Передаётся строкой в camelCase; тот же тип возвращается в board_type списка площадок.

Для создания площадки используйте loads. Другой тип приведёт к ошибке: площадки с машинами пока не поддерживаются. Числа и строки с числовым значением продолжают приниматься для совместимости; используйте строковое имя.

• loads — Площадка с грузами
• trucks — Площадка с машинами (зарезервировано, создание пока не поддерживается)

color: string

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

created_on*: date-time

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

departments_ids: [int32]

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

id: string

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

name: string

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

owner_ati_id: string

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

owner_firm*: int32

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

updated_on*: date-time

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

view_only_own*: boolean

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

}

Пример

{...}

"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_ati_id":"string",

"owner_firm":0,

"updated_on":"1970-01-01T00:00:00.000Z",

"view_only_own":false

}

400 Ошибка валидации или другая

Модель

{...}

error: string

Код ошибки

reason: string

Текст ошибки

details:{...}

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

any-key: {missing-type-info}

}

errors_list: [string]

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

}

Пример

{...}

"error":"string",

"reason":"string",

"details":{...},

"any-key":null

},

"errors_list":[...]

"string"

]

}

Консоль

Отправить

Параметры

Нет параметров

{ "all_departments_allowed": false, "board_exchange_direction": "input", "board_requirements": { "requirement_document_types": [ { "base_type_id": "inn", "custom_type_name": "string", "is_requirable": false } ], "rules": "string" }, "board_type": "loads", "color": "string", "departments_ids": [ 0 ], "description": "string", "name_for_users": "string", "private_name": "string", "public": false, "responsible_contact_id": 0, "subscribe_to_notifications": false }

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

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

Загрузить информацию по площадке

get /v2/boards/public/boards/{id}

Модель и примеры

Параметры

Параметр	Тип	Расположение	Описание
id обязательный	string	path	ID площадки Пример: 507f1f77bcf86cd799439011

Запрос

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

CURL

curl 'https://api.ati.su/v2/boards/public/boards/{id}' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v2/boards/public/boards/{id}");

Ответ

200 Данные о площадке

Модель

{...}

all_departments_allowed*: boolean

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

available_for_contact*: boolean

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

board_exchange_direction*: enum

[input, output, exchange]

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

Выбор неверного направления из допустимых значений создаст площадку с неподходящими правами, а не вызовет отказ. Неизвестное направление вызывает ошибку. Числа и строки с числовым значением принимаются для совместимости.

• input — Грузы и машины от участников к владельцу площадки
• output — Грузы и машины от владельца площадки к участникам
• exchange — Обмен грузами и машинами между всеми участниками

board_type*: enum

[loads, trucks]

Тип содержимого площадки. Передаётся строкой в camelCase; тот же тип возвращается в board_type списка площадок.

Для создания площадки используйте loads. Другой тип приведёт к ошибке: площадки с машинами пока не поддерживаются. Числа и строки с числовым значением продолжают приниматься для совместимости; используйте строковое имя.

• loads — Площадка с грузами
• trucks — Площадка с машинами (зарезервировано, создание пока не поддерживается)

color: string

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

created_on*: date-time

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

departments_ids: [int32]

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

id: string

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

name: string

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

owner_ati_id: string

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

owner_firm*: int32

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

updated_on*: date-time

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

view_only_own*: boolean

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

}

Пример

{...}

"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_ati_id":"string",

"owner_firm":0,

"updated_on":"1970-01-01T00:00:00.000Z",

"view_only_own":false

}

400 Ошибка валидации или другая

Модель

{...}

error: string

Код ошибки

reason: string

Текст ошибки

details:{...}

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

any-key: {missing-type-info}

}

errors_list: [string]

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

}

Пример

{...}

"error":"string",

"reason":"string",

"details":{...},

"any-key":null

},

"errors_list":[...]

"string"

]

}

Консоль

Отправить

Параметры

id ID площадки

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

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

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

get /v2/boards/public/boards/list

Модель и примеры

Параметры

Параметров нет

Запрос

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

CURL

curl 'https://api.ati.su/v2/boards/public/boards/list' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v2/boards/public/boards/list");

Ответ

200 Список площадок с их данными

Модель

[{...}]

all_departments_allowed*: boolean

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

available_for_contact*: boolean

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

board_exchange_direction*: enum

[input, output, exchange]

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

Выбор неверного направления из допустимых значений создаст площадку с неподходящими правами, а не вызовет отказ. Неизвестное направление вызывает ошибку. Числа и строки с числовым значением принимаются для совместимости.

• input — Грузы и машины от участников к владельцу площадки
• output — Грузы и машины от владельца площадки к участникам
• exchange — Обмен грузами и машинами между всеми участниками

board_type*: enum

[loads, trucks]

Тип содержимого площадки. Передаётся строкой в camelCase; тот же тип возвращается в board_type списка площадок.

Для создания площадки используйте loads. Другой тип приведёт к ошибке: площадки с машинами пока не поддерживаются. Числа и строки с числовым значением продолжают приниматься для совместимости; используйте строковое имя.

• loads — Площадка с грузами
• trucks — Площадка с машинами (зарезервировано, создание пока не поддерживается)

color: string

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

created_on*: date-time

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

departments_ids: [int32]

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

id: string

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

name: string

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

owner_ati_id: string

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

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

}]

Пример

[...]

{...}

"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_ati_id":"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

}

]

Консоль

Отправить

Параметры

Нет параметров

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

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

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

get /v2/boards/public/boards/canAdd

Модель и примеры

Параметры

Параметров нет

Запрос

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

CURL

curl 'https://api.ati.su/v2/boards/public/boards/canAdd' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v2/boards/public/boards/canAdd");

Ответ

200 Список площадок с их данными

Модель

[{...}]

all_departments_allowed*: boolean

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

available_for_contact*: boolean

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

board_exchange_direction*: enum

[input, output, exchange]

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

Выбор неверного направления из допустимых значений создаст площадку с неподходящими правами, а не вызовет отказ. Неизвестное направление вызывает ошибку. Числа и строки с числовым значением принимаются для совместимости.

• input — Грузы и машины от участников к владельцу площадки
• output — Грузы и машины от владельца площадки к участникам
• exchange — Обмен грузами и машинами между всеми участниками

board_type*: enum

[loads, trucks]

Тип содержимого площадки. Передаётся строкой в camelCase; тот же тип возвращается в board_type списка площадок.

Для создания площадки используйте loads. Другой тип приведёт к ошибке: площадки с машинами пока не поддерживаются. Числа и строки с числовым значением продолжают приниматься для совместимости; используйте строковое имя.

• loads — Площадка с грузами
• trucks — Площадка с машинами (зарезервировано, создание пока не поддерживается)

color: string

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

created_on*: date-time

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

departments_ids: [int32]

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

id: string

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

name: string

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

owner_ati_id: string

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

owner_firm*: int32

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

updated_on*: date-time

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

view_only_own*: boolean

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

}]

Пример

[...]

{...}

"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_ati_id":"string",

"owner_firm":0,

"updated_on":"1970-01-01T00:00:00.000Z",

"view_only_own":false

}

]

Консоль

Отправить

Параметры

Нет параметров

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

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

Получает список площадок, на которых участник может видеть грузы/машины

get /v2/boards/public/boards/canView

Модель и примеры

Параметры

Параметров нет

Запрос

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

CURL

curl 'https://api.ati.su/v2/boards/public/boards/canView' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v2/boards/public/boards/canView");

Ответ

200 Список площадок с их данными

Модель

[{...}]

all_departments_allowed*: boolean

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

available_for_contact*: boolean

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

board_exchange_direction*: enum

[input, output, exchange]

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

Выбор неверного направления из допустимых значений создаст площадку с неподходящими правами, а не вызовет отказ. Неизвестное направление вызывает ошибку. Числа и строки с числовым значением принимаются для совместимости.

• input — Грузы и машины от участников к владельцу площадки
• output — Грузы и машины от владельца площадки к участникам
• exchange — Обмен грузами и машинами между всеми участниками

board_type*: enum

[loads, trucks]

Тип содержимого площадки. Передаётся строкой в camelCase; тот же тип возвращается в board_type списка площадок.

Для создания площадки используйте loads. Другой тип приведёт к ошибке: площадки с машинами пока не поддерживаются. Числа и строки с числовым значением продолжают приниматься для совместимости; используйте строковое имя.

• loads — Площадка с грузами
• trucks — Площадка с машинами (зарезервировано, создание пока не поддерживается)

color: string

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

created_on*: date-time

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

departments_ids: [int32]

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

id: string

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

name: string

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

owner_ati_id: string

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

owner_firm*: int32

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

updated_on*: date-time

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

view_only_own*: boolean

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

}]

Пример

[...]

{...}

"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_ati_id":"string",

"owner_firm":0,

"updated_on":"1970-01-01T00:00:00.000Z",

"view_only_own":false

}

]

Консоль

Отправить

Параметры

Нет параметров

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

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

Получает список ID площадок, принадлежащих участнику АТИ.

get /v2/boards/public/boards/my

Модель и примеры

Параметры

Параметров нет

Запрос

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

CURL

curl 'https://api.ati.su/v2/boards/public/boards/my' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v2/boards/public/boards/my");

Ответ

200 Список ID площадок

Модель

[string]

Пример

[...]

"string"

]

Консоль

Отправить

Параметры

Нет параметров

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

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

Получает список ID площадок, на которых состоит участник АТИ.

get /v2/boards/public/boards/participating

Модель и примеры

Параметры

Параметров нет

Запрос

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

CURL

curl 'https://api.ati.su/v2/boards/public/boards/participating' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v2/boards/public/boards/participating");

Ответ

200 Список ID площадок

Модель

[string]

Пример

[...]

"string"

]

Консоль

Отправить

Параметры

Нет параметров

Добавление и настройка пользователей на Площадках

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

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

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

Приглашение участника ATI.SU на Площадку.

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

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

post /v2/boards/public/participants/invite

Модель и примеры

Параметры

Параметров нет

Запрос

Модель

{...}

ati_id: string

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

board_id: string

ID площадки

contact_id: int32

ID контакта

}

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

CURL

curl 'https://api.ati.su/v2/boards/public/participants/invite' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ati_id":"string","board_id":"string","contact_id":0}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/v2/boards/public/participants/invite", "{""ati_id"":""string"",""board_id"":""string"",""contact_id"":0}");

Ответ

200 ID приглашения

Модель

string

Пример

"string"

400 Ошибка валидации

Модель

{...}

error: string

Код ошибки

reason: string

Текст ошибки

details:{...}

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

any-key: {missing-type-info}

}

errors_list: [string]

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

}

Пример

{...}

"error":"string",

"reason":"string",

"details":{...},

"any-key":null

},

"errors_list":[...]

"string"

]

}

Консоль

Отправить

Параметры

Нет параметров

{ "ati_id": "string", "board_id": "string", "contact_id": 0 }

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

Метод возвращает список приглашений. Принятие и отклонение приглашений обрабатываются через заявки; метод модификации участия для этого не предназначен.

Получает список приглашений

get /v2/boards/public/participants/invite/my

Модель и примеры

Параметры

Параметров нет

Запрос

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

CURL

curl 'https://api.ati.su/v2/boards/public/participants/invite/my' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("GET", "https://api.ati.su", "/v2/boards/public/participants/invite/my");

Ответ

200 Список приглашений

Модель

[{...}]

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

board_info:{...}

Информация о площадке, на которую создано приглашение

all_departments_allowed*: boolean

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

available_for_contact*: boolean

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

board_exchange_direction*: enum

[input, output, exchange]

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

Выбор неверного направления из допустимых значений создаст площадку с неподходящими правами, а не вызовет отказ. Неизвестное направление вызывает ошибку. Числа и строки с числовым значением принимаются для совместимости.

• input — Грузы и машины от участников к владельцу площадки
• output — Грузы и машины от владельца площадки к участникам
• exchange — Обмен грузами и машинами между всеми участниками

board_type*: enum

[loads, trucks]

Тип содержимого площадки. Передаётся строкой в camelCase; тот же тип возвращается в board_type списка площадок.

Для создания площадки используйте loads. Другой тип приведёт к ошибке: площадки с машинами пока не поддерживаются. Числа и строки с числовым значением продолжают приниматься для совместимости; используйте строковое имя.

• loads — Площадка с грузами
• trucks — Площадка с машинами (зарезервировано, создание пока не поддерживается)

color: string

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

created_on*: date-time

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

departments_ids: [int32]

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

id: string

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

name: string

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

owner_ati_id: string

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

owner_firm*: int32

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

updated_on*: date-time

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

view_only_own*: boolean

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

}

participant:{...}

Параметры участия на площадке

ati_id: string

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

board_id: string

ID площадки

can_add: boolean

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

created_on*: date-time

Дата вступления (приглашения) на площадку

responsible_contact_id: int32

ID контакта, ответственного за площадку

sender_ati_id: string

код в АТИ пригласившего (владельца площадки)

type*: enum

[user, revoked, tempRejected, rejected, invited, invitedViewed, rejectedViewed, left, deleted, firmDeleted, owner]

Тип участия фирмы на площадке. Передаётся строкой в camelCase; при изменении участия допустимость перехода зависит от текущего типа и прав пользователя.

В публичных запросах используйте перечисленные типы без отметки «Внутреннее состояние». Недопустимый переход при изменении участия вызывает ошибку. Для совместимости JSON допускает числа, числовые строки и комбинации флагов через запятую, например "user, owner" (1 | 8192 = 8193). В participants/list такая комбинация означает точное совпадение типа с 8193, а не выбор участников user или owner; для фильтрации используйте один тип.

• user — Полноценный участник площадки
• revoked — Приглашение отозвано
• tempRejected — Внутреннее состояние: временный отказ от приглашения. Возвращается в participants/invite/my до завершения таймаута; не используйте для participants/modify
• rejected — Отказ от приглашения
• invited — Участник приглашён на площадку
• invitedViewed — Приглашение просмотрено
• rejectedViewed — Отказ просмотрен
• left — Участник покинул площадку
• deleted — Участник удалён с площадки
• firmDeleted — Участник удалён из АТИ
• owner — Владелец площадки

type_changed*: date-time

Время последней смены типа участия

view_content: boolean

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

view_participants: boolean

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

}

}]

Пример

[...]

{...}

"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_ati_id":"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

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

Message: string

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

}

Пример

{...}

"Code":"string",

"Message":"string"

}

Консоль

Отправить

Параметры

Нет параметров

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

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

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

post /v2/boards/public/participants/list

Модель и примеры

Параметры

Параметров нет

Запрос

Модель

{...}

board_ids: [string]

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

limit: int32

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

offset: int32

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

only_my*: boolean

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

type: enum

[user, revoked, tempRejected, rejected, invited, invitedViewed, rejectedViewed, left, deleted, firmDeleted, owner]

Тип участия фирмы на площадке. Передаётся строкой в camelCase; при изменении участия допустимость перехода зависит от текущего типа и прав пользователя.

В публичных запросах используйте перечисленные типы без отметки «Внутреннее состояние». Недопустимый переход при изменении участия вызывает ошибку. Для совместимости JSON допускает числа, числовые строки и комбинации флагов через запятую, например "user, owner" (1 | 8192 = 8193). В participants/list такая комбинация означает точное совпадение типа с 8193, а не выбор участников user или owner; для фильтрации используйте один тип.

• user — Полноценный участник площадки
• revoked — Приглашение отозвано
• tempRejected — Внутреннее состояние: временный отказ от приглашения. Возвращается в participants/invite/my до завершения таймаута; не используйте для participants/modify
• rejected — Отказ от приглашения
• invited — Участник приглашён на площадку
• invitedViewed — Приглашение просмотрено
• rejectedViewed — Отказ просмотрен
• left — Участник покинул площадку
• deleted — Участник удалён с площадки
• firmDeleted — Участник удалён из АТИ
• owner — Владелец площадки

}

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

CURL

curl 'https://api.ati.su/v2/boards/public/participants/list' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"board_ids":["string"],"limit":0,"offset":0,"only_my":false,"type":"user"}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/v2/boards/public/participants/list", "{""board_ids"":[""string""],""limit"":0,""offset"":0,""only_my"":false,""type"":""user""}");

Ответ

200 Список участий

Модель

{...}

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

result:[{...}]

Массив результатов

ati_id: string

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

board_id: string

ID площадки

can_add: boolean

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

created_on*: date-time

Дата вступления (приглашения) на площадку

responsible_contact_id: int32

ID контакта, ответственного за площадку

sender_ati_id: string

код в АТИ пригласившего (владельца площадки)

type*: enum

[user, revoked, tempRejected, rejected, invited, invitedViewed, rejectedViewed, left, deleted, firmDeleted, owner]

Тип участия фирмы на площадке. Передаётся строкой в camelCase; при изменении участия допустимость перехода зависит от текущего типа и прав пользователя.

В публичных запросах используйте перечисленные типы без отметки «Внутреннее состояние». Недопустимый переход при изменении участия вызывает ошибку. Для совместимости JSON допускает числа, числовые строки и комбинации флагов через запятую, например "user, owner" (1 | 8192 = 8193). В participants/list такая комбинация означает точное совпадение типа с 8193, а не выбор участников user или owner; для фильтрации используйте один тип.

• user — Полноценный участник площадки
• revoked — Приглашение отозвано
• tempRejected — Внутреннее состояние: временный отказ от приглашения. Возвращается в participants/invite/my до завершения таймаута; не используйте для participants/modify
• rejected — Отказ от приглашения
• invited — Участник приглашён на площадку
• invitedViewed — Приглашение просмотрено
• rejectedViewed — Отказ просмотрен
• left — Участник покинул площадку
• deleted — Участник удалён с площадки
• firmDeleted — Участник удалён из АТИ
• owner — Владелец площадки

type_changed*: date-time

Время последней смены типа участия

view_content: boolean

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

view_participants: boolean

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

}]

total_count*: int64

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

}

Пример

{...}

"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

}

400 Ошибка валидации или другая

Модель

{...}

error: string

Код ошибки

reason: string

Текст ошибки

details:{...}

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

any-key: {missing-type-info}

}

errors_list: [string]

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

}

Пример

{...}

"error":"string",

"reason":"string",

"details":{...},

"any-key":null

},

"errors_list":[...]

"string"

]

}

Консоль

Отправить

Параметры

Нет параметров

{ "board_ids": [ "string" ], "limit": 0, "offset": 0, "only_my": false, "type": "user" }

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

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

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

• Type меняет тип участия.
• CanAdd дает участнику право добавлять грузы на Площадку.
• ViewParticipants дает право видеть других участников.
• ViewContent дает право видеть грузы других участников Площадки.

Поменять параметры участника площадки Меняет параметры существующего участия на площадке. Не от всякого типа можно перейти к другому. Например, удалённого пользователя участником не сделать, а участника площадки нельзя сделать обратно приглашённым. Не все поля можно поменять, например, права участия может менять только владелец площадки, а не участник. ( `ViewParticipants`, `ViewContent`, `CanAdd` ).

post /v2/boards/public/participants/modify

Модель и примеры

Параметры

Параметров нет

Запрос

Модель

{...}

ati_id: string

ID участника ATI

board_id: string

ID площадки

can_add: boolean

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

type: enum

[user, revoked, tempRejected, rejected, invited, invitedViewed, rejectedViewed, left, deleted, firmDeleted, owner]

Тип участия фирмы на площадке. Передаётся строкой в camelCase; при изменении участия допустимость перехода зависит от текущего типа и прав пользователя.

В публичных запросах используйте перечисленные типы без отметки «Внутреннее состояние». Недопустимый переход при изменении участия вызывает ошибку. Для совместимости JSON допускает числа, числовые строки и комбинации флагов через запятую, например "user, owner" (1 | 8192 = 8193). В participants/list такая комбинация означает точное совпадение типа с 8193, а не выбор участников user или owner; для фильтрации используйте один тип.

• user — Полноценный участник площадки
• revoked — Приглашение отозвано
• tempRejected — Внутреннее состояние: временный отказ от приглашения. Возвращается в participants/invite/my до завершения таймаута; не используйте для participants/modify
• rejected — Отказ от приглашения
• invited — Участник приглашён на площадку
• invitedViewed — Приглашение просмотрено
• rejectedViewed — Отказ просмотрен
• left — Участник покинул площадку
• deleted — Участник удалён с площадки
• firmDeleted — Участник удалён из АТИ
• owner — Владелец площадки

view_content: boolean

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

view_participants: boolean

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

}

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

CURL

curl 'https://api.ati.su/v2/boards/public/participants/modify' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ati_id":"string","board_id":"string","can_add":false,"type":"user","view_content":false,"view_participants":false}'

1C

Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт
  ЗаголовкиHTTP = Новый Соответствие();
  ЗаголовкиHTTP.Вставить("Accept", "application/json");
  ЗаголовкиHTTP.Вставить("Content-Type", "application/json");
  ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}");
  HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP);
  HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать);
  ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);

  Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);

  Попытка
    Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос);
    Сообщить("Код ответа: " + Ответ.КодСостояния);
    Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8"));
  Исключение
    Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки());
  КонецПопытки;
КонецПроцедуры

ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/v2/boards/public/participants/modify", "{""ati_id"":""string"",""board_id"":""string"",""can_add"":false,""type"":""user"",""view_content"":false,""view_participants"":false}");

Ответ

200 успешно/не успешно

Успешный ответ

400 Ошибка валидации или другая

Модель

{...}

error: string

Код ошибки

reason: string

Текст ошибки

details:{...}

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

any-key: {missing-type-info}

}

errors_list: [string]

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

}

Пример

{...}

"error":"string",

"reason":"string",

"details":{...},

"any-key":null

},

"errors_list":[...]

"string"

]

}

Консоль

Отправить

Параметры

Нет параметров

{ "ati_id": "string", "board_id": "string", "can_add": false, "type": "user", "view_content": false, "view_participants": false }

Использование Площадок в грузах.

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

• Общая площадка. Грузы на ней будут доступны всем участникам Биржи ATI.SU. Она имеет постоянный идентификатор a0a0a0a0a0a0a0a0a0a0a0a0
• Персональная Площадка. На ней грузы доступны только для участников Площадки. Идентификаторы можно получить с помощью любого из методов получения Площадок