close

Вход

Забыли?

вход по аккаунту

?

Описание публичного API

Урл для GET запроса строится следующим образом:
http://DocMe.ru/admin/public/api/[имя метода]?[параметры]

Все запросы кроме uploadDocument должны вызываться с помощью GET или POST методов с UTF-8 кодировкой параметров.


uploadDocument


Синхронная закачка документа. Вызов этого метода делается с помощью запроса POST в multipart/form-data кодировке.
Параметры запроса:
параметр значение описание
userId integer ID пользователя на DocMe.ru
apiToken string Токен для доступа к апи. Его можно с генерировать на странице настроек пользователя
file data Закачиваемый файл

Формат ответа:
            <response>
              <id>[id]</id>
              <sign>[sign]</sign>
              <state>LOADING</state>
            </response>
            

Параметры ответа:
параметр значение описание
id integer id документа на DocMe.ru
sign string подпись, необходимая для последующих запросов
state "WAITING", "CONVERTING", "ERROR" статус документа, при успешной отправке задания, должно быть отлично от ERROR

uploadDocumentFromUrl


Метод асинхронно закачивает документ по указанной ссылке и отправляет его на конвертацию. Ответ генерируется еще до того как документ закачался и, возможно, до того как начал закачиваться.
Параметры запроса:
параметр значение описание
userId integer ID пользователя на DocMe.ru
apiToken string Токен для доступа к апи. Его можно сгенерировать на странице настроек пользователя
url string Урл исходного документа
format "doc", "docx", "xls" etc. Формат исходного документа

Формат ответа:
            <response>
              <id>[id]</id>
              <sign>[sign]</sign>
              <state>LOADING</state>
            </response>
            

Параметры ответа:
параметр значение описание
id integer ID документа на DocMe.ru
sign string подпись, необходимая для последующих запросов
state "LOADING", "ERROR" статус документа, при успешной отправке задания должно быть LOADING

getProgress


Возвращает статус конвертации документа.
Параметры запроса:
параметр значение описание
id integer ID документа на DocMe.ru
sign string подпись, полученная при вызове uploadDocumentFromUrl

Формат ответа:
            <response>
              <state>[state]</state>
              <message>[message]</message>
            </response>
            

Параметры ответа:
параметр значение описание
state "LOADING", "WAITING", "CONVERTING", "COMPLETE", "ERROR" статус документа
message string Описание ошибки

getDocumentList


Возвращает список документов пользователя.
Параметры запроса:
параметр значение описание
userId integer ID пользователя на DocMe.ru
apiToken string Токен для доступа к апи. Его можно сгенерировать на странице настроек пользователя
offset integer Позиция списка, начиная с которой выводятся документы
limit integer от 1 до 1000, максимум 1000 Максимальное количество результатов в ответе. По умолчанию 100

Формат ответа:
            <response>
              <totalResults>123</totalResults>
              <offset>0</offset>
              <limit>10</limit>
              <documents>
                <document>
                  <id>5512</id>
                  <key>4f5981bd58ef8711cc006875caaf9e5a</key>
                  <shortTitle>test</shortTitle>
                  ...
                </document>
                <document>
                  ...
                </document>
                ...
              </documents>
            </response>
            

removeDocument


Параметры запроса:
параметр значение описание
userId integer ID пользователя на DocMe.ru
apiToken string Токен для доступа к апи. Его можно сгенерировать на странице настроек пользователя
id integer ID документа на DocMe.ru

updateDocument


Параметры запроса:
параметр значение описание
userId integer ID пользователя на DocMe.ru
apiToken string Токен для доступа к апи. Его можно сгенерировать на странице настроек пользователя
id integer ID документа на DocMe.ru
title text Название документа
description text Описание документа
tags text Теги документа, разделенные [,;]
listingMode char H - скрытый, V - общедоступный
categoryId integer ID категории документа