Неформализованные документы

Данные методы работают только с определенными типами документов.

Список поддерживаемых типов документов:

акт

доверенность

договор

заказ

заказ (табличный вид)

заявка (к договору)

заявка к договору (табличный вид)

поручение экспедитору

счет

другой

Содержание

Последовательность вызовов для отправки документа с подписанием
Создание и редактирование документа
Прикрепление вложения к документу
Отправка документа
Экспорт документа для подписания
Подписание документа
Добавление комментария к документу
Отзыв документа
Получение документа
Одобрить документ
Отклонить документ
Скачать вложение к документу (тело документа)
Скачать zip-архив документа с вложениями и подписями
Список неформализованных документов в АТИ-Доках

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

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

Создание документа
Прикрепление вложения к документу
Отправка документа

Если вы хотите отправить документ с подписанием, то после нужно выполнить дополнительные действия:

Экспорт документа для подписания
Формирование подписи (выполняется на вашей стороне)
Подписание документа

Создание и редактирование документа

Позволяет создать черновик документа или обновить существующий документ. В методе передаётся общая метаинформация о документе. Список доступных doctype указан в разделе.

Создание и/или сохранение документа

post

/v1.0/atidocs/documents/

Развернуть все Свернуть все

body

object

{...}

Данные для создания документа

date: date

Дата документа

doc_recipient_contact: string

Код пользователя в ATI.SU в формате <код фирмы>.<id контакта>

doc_request: boolean

Флаг запроса решения для документа. Если это поле не передается, то для новых документов запрос решения остается без изменений. Если это передается, то в документе для флага будет использовано переданное значение.

doc_sender_contact: string

Код пользователя в ATI.SU в формате <код фирмы>.<id контакта>

doctype: enum

[акт, доверенность, договор, заказ, заказ (табличный вид), заявка (к договору), заявка к договору (табличный вид), поручение экспедитору, счет, другой]

Тип документа

id: string

Идентификатор документа

number: string

Номер документа

xmlBody: string

Тело документа в формате xml, в виде строки

}

CURL

Копировать

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

Ответ

200 Результат запроса

Развернуть все Свернуть все

Пример

Модель

{...}

"ok":true,

"result":"12345676554321"

}

{...}

Результат сохранения документа

ok: enum

[true]

result: string

Идентификатор документа

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Прикрепление вложения к документу

Позволяет прикрепить вложение к созданному документу. Фактически это тело документа.

Сохранить вложение

post

/gw/atidocs/api/2.0/documents/{doc_id}/attachments/

doc_id

string

id документа

file_upload

binary

CURL

Копировать

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

Ответ

200 Данные получены

Развернуть все Свернуть все

Пример

Модель

{...}

"ok":false,

"result":"string"

}

{...}

ok: enum

[true]

result: string

id документа

}

404 Документ не найден

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"not_found",

"reason":"Объект не найден"

}

{...}

error: string

reason: string

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Отправка документа

Предполагается, что документ уже сохранен и имеет приложенное вложение.

Отправить документ

put

/gw/atidocs/api/2.0/documents/{doc_id}/send/

doc_id

string

id документа

receiver

string

Код пользователя в ATI.SU в формате <код фирмы>.<id контакта>

CURL

Копировать

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

Ответ

200 Документ отправлен

Развернуть все Свернуть все

Пример

Модель

{...}

"ok":false,

"result":"string"

}

{...}

ok: enum

[true]

result: string

id документа

}

400 Не найден аккаунт получателя

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"document_no_receiver",

"reason":"Не найден аккаунт получателя"

}

{...}

error: string

reason: string

}

404 Объект не найден

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"not_found",

"reason":"Документ не найден"

}

{...}

error: string

reason: string

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Экспорт документа для подписания

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

Экспорт документа для подписи

post

/gw/atidocs/api/2.0/documents/{doc_id}/export/

doc_id

string

id документа

CURL

Копировать

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

Ответ

200 Документ экспортирован

Развернуть все Свернуть все

Пример

Модель

{...}

"ok":false,

"result":"string"

}

{...}

ok: enum

[true]

result: string

id документа

}

404 Документ не найден

Развернуть все Свернуть все

Пример

Модель

{...}

"error":true,

"reason":"Документ не найден"

}

{...}

error: boolean

reason: string

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Подписание документа

При помощи криптографических инструментов подписывает строку, которую вернул метод экспорта. При подписании сервер выполняет проверку подписи: сертификат клиента должен быть выдан доверенным УЦ.

Если документ требовал решения, то документ автоматически одобряется.

Более подробная информация про процесс подписания

Подписание документа

put

/v1.0/atidocs/documents/{doc_id}/sign/

doc_id

string

Идентификатор документа

Развернуть все Свернуть все

body

object

Объект с подписью документа в виде строки, кодированной в base64.

{...}

sign: string

Подпись документа в виде base64-строки

}

sign

string

CURL

Копировать

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

Ответ

200 Результат запроса

Развернуть все Свернуть все

Пример

Модель

{...}

"ok":true,

"result":"12345676554321"

}

{...}

Результат сохранения документа

ok: enum

[true]

result: string

Идентификатор документа

}

400 Ошибка при подписании документа.

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"bad_request",

"reason":"Ошибка в запросе"

}

{...}

Сообщение об ошибке

error*: string (nullable)

Код ошибки

reason*: string

Описание ошибки и возможная причина

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Добавление комментария к документу

Позволяет загрузить как текст, так и файл. Обязательное условие: текст/файл должен пересылаться как «multipart/form-data». При загрузке файлов применяются общие ограничения по типу поддерживаемых файлов. Размер файла не должен превышать 10 Мб.

Оставить комментарий к документу

post

/gw/atidocs/api/2.0/documents/{doc_id}/comments/

doc_id

string

id документа

comment-text

string

CURL

Копировать

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

Ответ

200 Список комментариев

Развернуть все Свернуть все

Пример

Модель

{...}

"timestamp":"2020-02-26T15:24:00.000Z",

"text":"string",

"has_attachments":false,

"attachment":{...},

"id":"95a971edb0994372aa6b76a9e1be8bdb",

"size":429939,

"name":"Книга новичка АТИ.pdf",

"mimetype":"application/pdf"

"user":{...}

"id":"765044.0",

"fn":"wefwef_1!"

}

{...}

timestamp: string

text: string

Текст сообщения

has_attachments: boolean

attachment:{...}

Данные вложения

id: string

size: integer

Размер файла

Название файла

mimetype: string

}

user:{...}

Данные пользователя

id: string

ati id

fn: string

Имя юзера

}

400 Ошибка запроса

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"bad_request",

"reason":"Нельзя отправить пустой комментарий"

}

{...}

error: string

reason: string

}

404 Объект не найден

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

not_found

reason: string

Документ не найден

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Отзыв документа

Метод доступен отправителю. После отзыва документ «пропадает» у получателя и переносится в папку «Черновики». Отозвать можно только отправленный документ.

Отозвать отправленный документ и сделать его черновиком

put

/gw/atidocs/api/2.0/documents/{doc_id}/revoke/

doc_id

string

id документа

CURL

Копировать

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

Ответ

200 Документ отозван

Развернуть все Свернуть все

Пример

Модель

{...}

"ok":false,

"result":"string"

}

{...}

ok: enum

[true]

result: string

id документа

}

400 Не указана причина отзыва документа

Развернуть все Свернуть все

Пример

Модель

{...}

"error":true,

"reason":"Не указана причина отзыва документа"

}

{...}

error: boolean

reason: string

}

404 Документ не найден

Развернуть все Свернуть все

Пример

Модель

{...}

"error":true,

"reason":"Документ не найден"

}

{...}

error: boolean

reason: string

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение документа

Позволяет получить документ по его идентификатору doc_id.

Получение документа

get

/gw/atidocs/api/2.0/documents/{doc_id}/

doc_id

string

Идентификатор документа

CURL

Копировать

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

Ответ

200 Сведения о документе

Развернуть все Свернуть все

Пример

Модель

{...}

"ok":true,

"result":{...}

"doctype":"Тип документа",

"sender":{...},

"ati_id":"0",

"name":"Имя",

"user":{...},

"ati_id":"0",

"name":"Имя пользователя",

"department_id":"0"

"status":"Статус документа",

"inn":""

"receiver":{...},

"ati_id":"0",

"name":"Имя",

"user":{...},

"ati_id":"0",

"name":"Имя пользователя",

"department_id":"0"

"status":"Статус документа"

"file":{...},

"mimetype":"application/vnd.ati-docs.xml",

"name":"000.xml",

"xml_template":"order",

"timestamp":"2022-06-30T12:44:30Z",

"size":9659,

"id":"00000"

"id":"00000",

"date":"2022-06-30",

"number":"1",

"updated":"2022-06-30T12:44:28Z",

"fix_price":{...},

"id":"00000",

"link":"",

"original_owner":"0",

"contact_1":"0",

"contact_2":"",

"document_creator":"0"

"flags":[...]

"is_sent",

"is_waiting",

"can_be_deleted",

"can_be_archived",

"can_be_signed",

"can_be_declined",

"can_be_revoked",

"can_be_templated"

]

}

{...}

ok: enum

[true]

result:{...}

id: string

Идентификатор документа

file:{...}

id: string

Идентификатор файла

timestamp: string

Дата и время загрузки файла

Имя файла

mimetype: string

mimetype файла

xml_template: string

size: string

Размер файла в байтах

}

number: string

Номер документа

date: string

doctype: string

Тип документа

updated: string

Дата и время последнего обновления документа

sender:{...}

Отправитель документа

ati_id: string

Идентификатор фирмы в ATI.SU (код в АТИ)

Название фирмы

user:{...}

ati_id: string

Идентификатор фирмы и контакта

Название контакта

}

status: string

inn: string

}

receiver:{...}

Получатель документа

ati_id: string

Идентификатор фирмы в ATI.SU (код в АТИ)

Название фирмы

user:{...}

ati_id: string

Идентификатор фирмы и контакта

Название контакта

}

status: string

inn: string

}

comments:{...}

Количество комментариев

last: string

Последний комментарий

}

fix_price:{...}

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

id: string

Идентификатор заказа

link: string

Ссылка на заказ

original_owner: string

contact_1: string

contact_2: string

document_creator: string

}

flags: [string]

Флаги документа сообщающие о доступных действиях

}

404 Документ не найден

Развернуть все Свернуть все

Пример

Модель

{...}

"error":false,

"reason":"Документ не найден"

}

{...}

Документ не найден

error: enum

[true]

reason: enum

[Документ не найден]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Одобрить документ

Метод доступен получателю. Одобрить можно только документ, ожидающий решения.

Одобрить документ

put

/gw/atidocs/api/2.0/documents/{doc_id}/approve/

doc_id

string

id документа

CURL

Копировать

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

Ответ

200 Документ одобрен

Развернуть все Свернуть все

Пример

Модель

{...}

"ok":false,

"result":"string"

}

{...}

ok: enum

[true]

result: string

id документа

}

400 Документ не может быть одобрен

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"document_can_not_be_approved",

"reason":"Документ не может быть одобрен"

}

{...}

error: string

reason: string

}

404 Документ не найден

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

not_found

reason: string

Объект не найден

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Отклонить документ

Метод доступен получателю. Отклонить можно только документ, ожидающий решения.

Отклонить документ

put

/gw/atidocs/api/2.0/documents/{doc_id}/decline/

doc_id

string

id документа

reason

string

CURL

Копировать

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

Ответ

200 Документ отклонен

Развернуть все Свернуть все

Пример

Модель

{...}

"ok":false,

"result":"string"

}

{...}

ok: enum

[true]

result: string

id документа

}

400 Документ не может быть одобрен

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"document_can_not_be_changed",

"reason":"Документ невозможно изменить, так как вторая сторона приняла по нему решение. Обновите страницу, чтобы продолжить работу"

}

{...}

error: string

reason: string

}

404 Документ не найден

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

not_found

reason: string

Объект не найден

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Скачать вложение к документу (тело документа)

При скачивании в заголовке отдается mimetype документа, если его удалось определить.

Получить вложение по id документа

get

/gw/atidocs/api/2.0/documents/{doc_id}/attachments/{attachment_id}/

doc_id

string

id документа

attachment_id

string

id вложения

CURL

Копировать

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

Ответ

200 Данные получены

Развернуть все Свернуть все

Пример

Модель

"binary"

binary

404 Объект не найден

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"not_found",

"reason":"Документ не найден"

}

{...}

error: string

reason: string

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Скачать zip-архив документа с вложениями и подписями

Позволяет скачать zip-архив документа, только если у документа есть подпись хотя бы с одной стороны.

Скачать zip-архив документа с вложениями и подписями

get

/v1.0/atidocs/documents/{doc_id}/zip_archive/

doc_id

string

Идентификатор документа

CURL

Копировать

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

Ответ

200 ZIP-архив

Развернуть все Свернуть все

Загрузка...

Развернуть все Свернуть все

Загрузка...