Программный интерфейс приложений (API)
для работы с ИС «ЭДО.ПОТОК»

Описывается программный интерфейс приложений (API), предоставляющий возможность сторонним приложениям использовать данные из информационной системы (ИС) ЭДО.ПОТОК для обмена юридически значимыми электронными документами.
Взаимодействие клиентского приложения и API производится путем отправки приложением HTTP-запросов к серверу и получением ответов на них. Для отправки запросов и получения ответов используется протокол HTTPS.
Проблемы использования ИС «ЭДО.ПОТОК», которые не удалось решить самостоятельно, читая техническую и пользовательскую документацию, скорее всего, получится решить, позвонив в службу технической поддержки по телефону 8 (800) 550-99-11.
Ниже описаны запросы HTTP, которыми реализуются функции API по работе с ИС «ЭДО.ПОТОК».

Кодировка, используемая в запросах и ответах — Windows-1251. Запросы выполняются методами POST и GET, параметры запроса располагаются в структуре данных формата JSON, передаваемой в блоке данных запроса (при использовании POST), также параметры могут передаваться в строке запроса (при использовании GET).
Ответы выдаются сервером в формате JSON и, в случае успешности ответа согласно его заголовку (код ответа по протоколу HTTP равен 200), данные имеют следующий обобщенный вид:

{
  "status": {
    "code": 0,
    "message": "string"
  }
  "result": {
  ...
  }
}

Здесь ключу «result» соответствует произвольный тип данных (часто — структура данных, вид которой определяется видом запроса); «status» — структура, описывающая состояние обработки запроса; состав и назначение полей в данной структуре см. в таблице 1 в п. 2.1.

Доступ в ИС «ЭДО.ПОТОК» возможен при использовании учетной записи пользователя. Для получения доступа к учетной записи пользователя необходимо успешно пройти процедуру авторизации, которая в рамках ИС «ЭДО.ПОТОК» может производиться двумя способами: с помощью имени и пароля и с помощью механизма AuthToken.
После успешной авторизации любым способом пользователь получает токен, который далее используется двумя способами: добавляется в заголовок запроса по протоколу HTTP, либо используется как дополнительный параметр к любому запросу к ИС «ЭДО.ПОТОК», при этом к запросу должна быть добавлена следующая последовательность символов:

&token=TOKEN1

Здесь TOKEN1 — токен, возвращенный в результате авторизации (см. пп. 2.1 и 2.2). В дальнейшем токен, как дополнительный параметр, при описании запросов упоминаться не будет.
Использование токена в заголовках запросов (HTTP-headers) предполагает при формировании запроса добавление заголовка следующего вида:

Authorisation: Token TOKEN1

Здесь TOKEN1 — также, токен, возвращенный в результате авторизации.

Для авторизации с помощью логина и пароля применяется HTTP-запрос, в котором передаются имя пользователя и пароль в формате JSON. Запрос имеет следующий вид:

POST https://edmapi.ofd.ru/api/edo/VERSION/clients/auth

Здесь VERSION — обозначение текущей версии системы, по умолчанию равное v1, но впоследствии номер версии может быть другим. Имя и пароль передаются в теле запроса, которое выглядит так (приведены примеры значений):

{
  "clientId": "2PS-0078414651",
  "password": "PASSWORD"
}

Здесь clientId — уникальный идентификатор клиента в ИС «ЭДО.ПОТОК», password — пароль клиента в ИС «ЭДО.ПОТОК». Оба поля являются обязательными для заполнения. В ответ на запрос сервер возвращает структуру данных (приведены примеры значений):

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": "c698a3c9-d22f-4a93-9a8d-d8310cac326a"
}

Назначение полей ответа приведено в таблице 1.

Таблица 1. Поля структуры данных ответа

Вторым доступным пользователю механизмом авторизации в ИС «ЭДО.ПОТОК» является авторизация посредством механизма AuthToken, которая в данном случае предполагает использование квалифицированной электронной подписи (КЭП). Для авторизации необходимо проделать следующую последовательность действий.
1. Со стороны клиента должен быть направлен запрос следующего вида:

GET https://edmapi.ofd.ru/api/edo/VERSION/clients/auth-with-ds?fingerprint=FPRINT1

Здесь VERSION — обозначение текущей версии системы, по умолчанию равное v1, но впоследствии номер версии может быть другим, FPRINT1 — отпечаток сертификата. В ответ на данный запрос возвращается структура данных вида, описанного в разд. 1 и таблице 1 в пп. 2.1. Поле с ключом «result» имеет тип данных «Строка», и в нем возвращается строка для подписания, которая будет использована в следующих шагах.
2. Клиент подписывает строку для подписания с помощью КЭП, а затем отправляет ее вместе с подписью (CMS detached container), закодированную по алгоритму “Base64”, на тот же адрес URL с помощью запроса следующего вида:

POST https://edmapi.ofd.ru/api/edo/VERSION/clients/auth-with-ds

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

{
  "cmsDetached": "UTA9STK1",
  "content": "IDMYUTA9STK11070FQL..."
}

Назначение полей тела запроса приведено в таблице 2.

Таблица 2. Поля структуры данных ответа

3. Сервер производит проверку переданной строки, и в случае успешной проверки возвращает ответ, структура которого описана в разд. 1 и таблице 1 в пп. 2.1; поле «result» имеет тип «Строка», и его значением является токен, далее использующийся в запросах к API в качестве обязательного дополнительного параметра.

Запросы (функции) программного интерфейса приложений ИС «ЭДО.ПОТОК» предназначены для выполнения операций документооборота (пересылка, сохранение, подписание документов) для внешних информационных систем, взаимодействующих с ИС «ЭДО.ПОТОК».
Большинство запросов и ответов имеет вид, описанный в разд. 1, если входные и выходные данные будут другого вида, это будет описываться дополнительно. Данные документов при передаче кодируются алгоритмом “Base64”.
Запросы API ИС «ЭДО.ПОТОК» можно разделить на три группы: запросы, связанные с документами, запросы связанные с клиентами и запросы, связанные с контрагентами. К запросам, связанным с клиентами относится также и авторизация пользователя в системе, описанная в разд. 2.

Для получения списка документов клиента используется HTTP-метод “GET”, в ответ на запрос возвращается список документов клиента, в соответствии с переданным токеном. Список документов клиента может быть запрошен как по всему времени пользования системой, так и по заданному периоду (см. ниже). Также может быть запрошен как полный список документов, так и его часть (страница), исходя из принципа деления списка на страницы равной длины; длина страницы и номер выдаваемой страницы определяются в параметрах запроса (см. ниже).
Запрос на получение списка документов клиента имеет вид:

GET https://edmapi.ofd.ru/api/edo/VERSION/documents?direction=DIRECTION&from=DATE1&to=DATE2&pageIndex=INDEX&pageRecords=NUM1&sortKey=KEY1&sortDirection=DIR1&typeOfDate=TYPE

Все параметры в данном запросе приведены в таблице 3.

Таблица 3. Параметры запроса на получение списка документов

mm — месяц, yyyy — год | | нет |

Далее здесь во всех запросах будет указана первая версия API (“v1”). Пример запроса с использованием аутентификации в заголовках запросов (HTTP-headers):

GET https://edmapi.ofd.ru/api/edo/v1/documents?direction=out&from=31.08.2018&to=01.09.2018&pageIndex=1&pageRecords=50&sortKey=Doc_id&sortDirection=asc&docType=without_service_docs

или с использованием аутентификации в параметрах запросов:

GET https://edmapi.ofd.ru/api/edo/v1/documents?direction=out&from=31.08.2018&to=01.09.2018&pageIndex=1&pageRecords=50&sortKey=Doc_id&sortDirection=asc&docType=without_service_docs&token=c698a3c9-d22f-4a93-9a8d-d8310cac326a

Пример успешного ответа на запрос (с примерами значений):

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": {
    "data": [
      {
        "docId": 2610,
        "fromOrgId": "2PS-003245025998032",
        "fromOrgName": "PS ST",
        "toOrgId": "2PS-00440111648005445",
        "toOrgName": "ИП Иванов",
        "docTypeId": 1,
        "docTypeName": "Счёт-фактура",
        "docStateId": 0,
        "docStateName": "Создан",
        "sfStateName": "Подписано отправителем",
        "sfStateId": 3,
        "xmlBody": "PD94bWwgdmVyc2...",
        "imgBody": null,
        "signature": "MIIGGAYJKoZIhvcNAQcCoII Строка...",
        "fileName": "ON_SCHFDOPPR_2PS-0069110332410689418822_2PS-007841465194609667_20180820_80aa0ec5-d512-48a1-b504-7d84872d5dcf",
        "certFingerprint": "4ff4214c64e8d8db2046defab0dAAAA",
        "updated": "2018-08-31 13:17"
       }
     ],
    "pageInfo": {
      "pageIndex": 1,
      "pageRecords": 1000,
      "pageCount": 1,
      "sortKey": "doc_id",
      "sortDirection": "desc"
    }
  }
}

Параметры структуры приведены в таблице 4.

Таблица 4. Параметры структуры данных ответа на запрос формирования кассового чека

Для отправки формализованного документа заданному получателю используется запрос на основе метода POST; запрос имеет следующий вид:

POST https://edmapi.ofd.ru/api/edo/VERSION/documents/send

Здесь VERSION — обозначение текущей версии системы, по умолчанию равное v1, но впоследствии номер версии может быть другим. Параметры запроса располагаются в теле запроса и имеют вид следующей структуры:

{
  "to": "2PS-00631566061106315010010016107897",
  "docType": 7,
  "content": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNv...",
  "signature": "MIIGGAYJKoZIhvcNAQcCoIIGCTCCBg...",
  "fileName": "my_file.txt",
  "parentDocId": "",
  "docAttrs": {
    "docName": "docName",
    "docNumber": "N-345",
    "docDate": "04.10.2018",
    "sumAll": "154.3",
    "sumNds": "12.3",
    "isNds": true,
    "isSignRequested": false
  }
}

Все параметры (поля) для запроса приведены в таблице 5.

Таблица 5. Параметры запроса на отправку документа

Пример успешного ответа на запрос описан в разд. 1, при этом параметр «message» имеет значение «OK», а «result» имеет значение «null».

Для получения клиентом списка документов для подписания используется HTTP-метод “GET”, в ответ на запрос возвращается список документов, в соответствии с переданным токеном. Запрос на получение списка документов на подписание имеет вид:

GET https://edmapi.ofd.ru/api/edo/VERSION/documents/for-signing?req-duplex-sign=REQ1

Параметры запроса приведены в таблице 6.

Таблица 6. Параметры запроса на получение списка документов для подписания

Пример успешного ответа на запрос имеет следующий вид (с примерами значений):

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": [
    {
      "docId": 4483,
      "fromOrgId": "252",
      "fromOrgName": "ООО ПС-СТ",
      "toOrgId": "1",
      "toOrgName": "ОФД.РУ",
      "edoIdFrom": "2PS-00324502599803245010010096511518",
      "edoIdTo": "2PS",
      "docTypeId": 3,
      "docTypeName": "Извещение о получении электронного документа",
      "docStateId": 0,
      "docStateName": "Ожидается извещение о получении",
      "sfStateName": "Ожидается извещение о получении",
      "sfStateId": 2,
      "content": "PD94bWwgdmVyc2lvbiA9IjEuMCIgZW5jb2R...",
      "signature": null,
      "fileName": "DP_IZVPOL_2PS_2PS-0032450259980324...",
      "certFingerprint": null,
      "docName": null,
      "docNumber": null,
      "docDate": null,
      "sumAll": null,
      "sumNds": null,
      "updated": "17.10.2018 11:15:01",
      "nds": false
    }
  ]
}

Параметры ответа приведены в таблице 7.

Таблица 7. Параметры ответа на запрос списка документов на подписание

Для отправки формализованного документа заданному получателю используется запрос на основе метода POST; запрос имеет следующий вид:

POST https://edmapi.ofd.ru/api/edo/VERSION/documents/add-signature

Здесь VERSION — обозначение текущей версии системы, по умолчанию равное v1, но впоследствии номер версии может быть другим. Параметры запроса располагаются в теле запроса и имеют вид следующей структуры (приведены примеры значений):

{
  "docId": "2614",
  "signature": "MIIGGAYJKoZ…"
}

Все параметры (поля) для запроса приведены в таблице 8.

Таблица 8. Параметры запроса на отправку документа

Пример успешного ответа на запрос описан в разд. 1, при этом параметр «message» имеет значение «OK», а «result» имеет значение «null».

Для удаления документа используется запрос на основе метода POST; запрос имеет следующий вид:

POST https://edmapi.ofd.ru/api/edo/VERSION/documents/remove-doc

Здесь VERSION — обозначение текущей версии системы, по умолчанию равное v1, но впоследствии номер версии может быть другим. Параметры запроса располагаются в теле запроса и имеют вид следующей структуры (приведены примеры значений):

{
  "docId": "2604"
}

Здесь docId — идентификатор удаляемого документа. Пример успешного ответа на запрос описан в разд. 1, при этом параметр «message» имеет значение «OK», а «result» имеет значение «null».

Для восстановления удаленного документа используется запрос на основе метода POST; запрос имеет следующий вид:

POST https://edmapi.ofd.ru/api/edo/VERSION/documents/recover-doc

Здесь VERSION — обозначение текущей версии системы, по умолчанию равное v1, но впоследствии номер версии может быть другим. Параметры запроса располагаются в теле запроса и имеют вид следующей структуры (приведены примеры значений):

{
  "docId": "2604"
}

Здесь docId — идентификатор удаляемого документа. Пример успешного ответа на запрос описан в разд. 1, при этом параметр «message» имеет значение «OK», а «result» имеет значение «null».

Для добавления к документу уточняющей информации (комментария) используется запрос на основе метода POST; запрос имеет следующий вид:

POST https://edmapi.ofd.ru/api/edo/VERSION/documents/request-clarification

Здесь VERSION — обозначение текущей версии системы, по умолчанию равное v1, но впоследствии номер версии может быть другим. Параметры запроса располагаются в теле запроса и имеют вид следующей структуры (приведены примеры значений):

{
  "docId": "4483",
  "comment": "test comment"
}

Здесь docId — идентификатор удаляемого документа, comment — текст уточнения (комментария), добавляемый к документу, параметр обязателен в запросе. Пример успешного ответа на запрос имеет следующий вид (с примерами значений):

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": {
    "docId": 4483,
    "fromOrgId": "252",
    "fromOrgName": "ООО ПС-СТ",
    "toOrgId": "1",
    "toOrgName": "ОФД.РУ",
    "docTypeId": 3,
    "docTypeName": "Извещение о получении электронного документа",
    "docStateId": 0,
    "docStateName": "Ожидается извещение о получении",
    "sfStateName": "Ожидается извещение о получении",
    "sfStateId": 2,
    "content": "PD94bWwgdmVyc2lvbj0iMTItLRIN...",
    "signature": null,
    "fileName": "DP_IZVPOL_2PS_2PS-0032450259980324...",
    "certFingerprint": null,
    "sumAll": null,
    "sumNds": null,
    "updated": "17.10.2018 11:15:01"
  }
}

Параметры ответа приведены в таблице 9.

Таблица 9. Параметры ответа на запрос списка документов на подписание

Для получения детализированной информации о документе используется запрос на основе метода GET; запрос имеет следующий вид:

GET https://edmapi.ofd.ru/api/edo/VERSION/documents/document?docId=ID1

Здесь VERSION — обозначение текущей версии системы, по умолчанию равное v1, но впоследствии номер версии может быть другим, ID1 — идентификатор документа, информация о котором запрашивается. Пример успешного ответа на запрос имеет следующий вид (с примерами значений):

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": {
    "docId": 4483,
    "fromOrgId": "252",
    "fromOrgName": "ООО ПС-СТ",
    "toOrgId": "1",
    "toOrgName": "ОФД.РУ",
    "edoIdFrom": "2PS-00324502599803245010010096511518",
    "edoIdTo": "2PS",
    "docTypeId": 3,
    "docTypeName": "Извещение о получении электронного документа",
    "docStateId": 0,
    "docStateName": "Ожидается извещение о получении",
    "sfStateName": "Ожидается извещение о получении",
    "sfStateId": 2,
    "content": "PD94bWwgdmVyc2lvbj0iMTItLRIN...",
    "signature": null,
    "fileName": "DP_IZVPOL_2PS_2PS-0032450259980324...",
    "certFingerprint": null,
    "sumAll": null,
    "sumNds": null,
    "updated": "17.10.2018 11:15:01"
  }
}

Структура данного ответа во многом напоминает структуру ответа на запрос о добавлении уточнения к документу. Параметры ответа имеют то же самое назначение и описаны в таблице 9, п. 3.1.7; параметры edoIdFrom и edoIdTo аналогичны параметрам с теми же ключами (именами, идентификаторами), описанными в п. 3.1.3.

Запросить комплект связанных документов можно с помощью запроса на основе метода GET, при этом в ответе будут присутствовать все документы комплекта (СФ, ИСФ, КСФ, ИКСФ); запрос имеет следующий вид:

GET https://edmapi.ofd.ru/api/edo/VERSION/documents/doc-chain?docId=ID1

Здесь VERSION — обозначение текущей версии системы, по умолчанию равное v1, но впоследствии номер версии может быть другим, ID1 — идентификатор одного из документов комплекта, параметр обязателен в запросе. Успешный ответ на запрос имеет вид, аналогичный ответу, приведенному в п. 3.1.3.

Запросить справочник типов документов, определенных в системе, с указанием их названия, внутреннего идентификатора и признака формализованности можно с помощью запроса на основе метода GET; запрос имеет следующий вид:

GET https://edmapi.ofd.ru/api/edo/VERSION/documents/doc-type-dictionary

Здесь VERSION — обозначение текущей версии системы, по умолчанию равное v1, но впоследствии номер версии может быть другим. Успешный ответ на запрос имеет следующий вид:

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": [
    {
      "id": 1,
      "name": "Счёт-фактура",
      "formalized": true
    }
  ]
}

Параметры ответа приведены в таблице 10.

Таблица 10. Параметры ответа на запрос справочника типов документов

Запросить содержимое документа можно с помощью запроса на основе метода GET, при этом в ответе будут присутствовать все документы комплекта (СФ, ИСФ, КСФ, ИКСФ); запрос имеет следующий вид:

GET https://edmapi.ofd.ru/api/edo/VERSION/documents/download-doc?docId=ID1&downloadType=TYPE1

Параметры запроса приведены в таблице 11.

Таблица 11. Параметры запроса загрузки документа

В ответ на данный запрос начинается загрузка файла в двоичном виде; в заголовках ответа (response headers) указывается имя загружаемого файла.

В некоторых случаях необходимо, чтобы ИС «ЭДО.ПОТОК» возвращала предварительно заполненные шаблоны XML-документов для УПД-покупателя, УКД покупателя, либо уточняющего документа. Данные документы могут быть частично сформированы на стороне оператора ЭДО по данным родительского документа (СФ, УПД, УКД); недостающая часть информации вводится пользователем ИС «ЭДО.ПОТОК» на веб-странице вручную.
Запросить предварительно заполненные шаблоны XML-документов можно с помощью запроса на основе метода POST; запрос имеет следующий вид:

POST https://edmapi.ofd.ru/api/edo/VERSION/documents/get-doc-template

Здесь VERSION — обозначение текущей версии системы, по умолчанию равное v1, но впоследствии номер версии может быть другим. Параметры запроса располагаются в теле запроса и имеют вид следующей структуры (приведены примеры значений):

{
  "docTypeId": 6,
  "parentDocId": 3972,
  "textRefinement": "Текстовый комментарий"
}

Все параметры (поля) для запроса приведены в таблице 12.

Таблица 12. Параметры запроса предварительно заполненной формы

Пример успешного ответа на запрос имеет следующий вид (с примерами значений):

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNv..."
}

Параметры (поля) ответа приведены в таблице 13.

Таблица 13. Параметры ответа на запрос предварительно заполненной формы

Документ в формате “Adobe PDF” удобен для просмотра и печати, возможность генерации такого документа присутствует в ИС «ЭДО.ПОТОК», это действие возможно произвести с помощью запроса на основе HTTP-метода GET. Запрос имеет следующий вид:

GET https://edmapi.ofd.ru/api/edo/VERSION/documents/show-doc-pdf?docId=ID1

Здесь VERSION — обозначение текущей версии системы, по умолчанию равное v1, но впоследствии номер версии может быть другим; ID1 — идентификатор документа, на основе которого по запросу генерируется документ в формате “Adobe PDF”; параметр обязателен.
В ответ на данный запрос начинается загрузка файла в двоичном виде; в заголовках ответа (response headers) указывается имя загружаемого файла.

Помимо запросов к ИС «ЭДО.ПОТОК», предназначенных для работы с документами, существует группа запросов, возвращающих справочную информацию по клиентам ИС «ЭДО.ПОТОК», которые могут идентифицироваться как по своим ИНН и КПП, так и по внутреннему идентификатору, предоставленному клиенту ИС «ЭДО.ПОТОК».

Для получения информации о клиенте по его ИНН и КПП можно использовать запрос ИС «ЭДО.ПОТОК», действующий на основе HTTP-метода GET; запрос имеет следующий вид:

GET https://edmapi.ofd.ru/api/edo/VERSION/clients?inn=INN&kpp=KPP

Параметры запроса приведены в таблице 14.

Таблица 14. Параметры запроса загрузки документа

Пример успешного ответа на запрос имеет следующий вид (с примерами значений):

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result ": {
    "clientId": "2PS-00278567668300483440610014472643",
    "fullName": "ООО \"Рога и копыта\"",
    "phone": "79103333412",
    "email": "RogaIKopyta@rk.ru",
    "mailAddress": null,
    "fullLegalAddress": "Брянск г Брянской Пролетарской Дивизии ул 9",
    "kpp": "048344061",
    "inn": "2785676683",
    "ogrn": "5097571958996",
    "ifns": null,
    "certificate": null,
    "stateName": null,
    "legalAddress": {
      "building": null,
      "houseNumber": null,
      "office": null,
      "postalCode": null,
      "region": null,
      "settlement": null,
      "street": null
    }
  }
}

Параметры (поля) ответа приведены в таблице 15.

Таблица 15. Параметры ответа на запрос предварительно заполненной формы

Для получения информации о клиенте по его уникальному идентификатору внутри системы можно использовать запрос ИС «ЭДО.ПОТОК», действующий на основе HTTP-метода GET; запрос имеет следующий вид:

GET https://edmapi.ofd.ru/api/edo/VERSION/clients?clientId=ID1

Здесь VERSION — обозначение текущей версии системы, по умолчанию равное v1, но впоследствии номер версии может быть другим; ID1 — идентификатор клиента, параметр является обязательным. Успешный ответ на запрос аналогичен приведенному в п. 3.2.1, назначение полей описано в таблице 15.

Существует группа запросов к ИС «ЭДО.ПОТОК», предназначенных для получения данных о взаимодействующих с клиентами контрагентах.

По данному запросу ИС «ЭДО.ПОТОК» производит поиск информации о контрагентах, параметры которых соответствуют задаваемым в параметрах запроса фильтрам поиска. Запрос построен на основе HTTP-метода GET и имеет следующий вид:

GET https://edmapi.ofd.ru/api/edo/VERSION/contractors/search-contractors?status=STATUS1&clientNamePart=NAME1&inn=INN&kpp=KPP

Параметры запроса приведены в таблице 14.

Таблица 14. Параметры запроса загрузки документа

Успешный ответ на запрос имеет следующий вид:

{
  "status": {
    "code": 0,
    "message": "OK"
  },
  "result": {
    "data": [
      {
        "clientId": "2PS-00278567668300483440610014472643",
        "fullName": "ООО \"Рога и копыта\"",
        "phone": "79103333412",
        "email": "RogaIKopyta@rk.ru",
        "mailAddress": null,
        "fullLegalAddress": "Брянск г Брянской Пролетарской Дивизии ул 9",
        "kpp": "048344061",
        "inn": "2785676683",
        "ogrn": "5097571958996",
        "ifns": null,
        "certificate": null,
        "stateName": null,
        "legalAddress": {
          "postalCode": null,
          "region": null,
          "area": null,
          "city": null,
          "settlement": null,
          "street": null,
          "houseNumber": null,
          "building": null,
          "office": null,
        }
      },
      "status": "NEW"
    ],
    "pageInfo": {
      "pageIndex": 1,
      "pageRecords": 1,
      "pageCount": 239,
      "sortKey": NULL,
      "sortDirection": "desc"
    }
  }
}

Параметры (поля) ответа приведены в таблице 15.

Таблица 15. Параметры ответа на запрос предварительно заполненной формы

Для получения списка контрагентов выбранного клиента применяется запрос, построенный на HTTP-методе GET и имеющий следующий вид:

GET https://edmapi.ofd.ru/api/edo/VERSION/contractors?clientNamePart=STR&pageRecords=NUM

Параметры запроса приведены в таблице 16.

Таблица 16. Параметры запроса загрузки документа

Результатом запроса является структура данных, подобная описанной в п. 3.3.1, назначение полей описано в таблице 15.

Добавлять сертификат электронной подписи можно с помощью специального запроса, имеющегося в составе данного API, при этом надо учитывать, что после добавления запроса все сертификаты текущего пользователя, имеющиеся в системе до момента добавления, станут неактивными, добавленный сертификат будет обозначен, как активный. Запрос добавления сертификата производится с помощью метода POST и имеет следующий вид:

POST https://edmapi.ofd.ru/api/edo/VERSION/clientscert-add

Здесь VERSION — обозначение текущей версии системы, по умолчанию равное v1, но впоследствии номер версии может быть другим. Блок данных сертификата располагается в теле запроса и имеет следующий вид (пример значения приведен частично, строка может иметь длину в несколько тысяч символов):

{
  "cert":
"MIIG+zCCBqiBDwICHjAKBgYqhQMCAgMFADCCATExCzAJBgNV\nBAYTAlJVMQ …
…
nq3ynlarm4N79KkLtSQ5BXGuL3z3xkZ0agZ+P34zQk5tiFvzQ9M3EEPasReHGgglf\nUJrq2BwaibC7O5yJE1P5\n"
}

По ключу «cert» содержится новый сертификат электронной подписи, добавляемый в учетную запись. Параметр является обязательным.

Версия 2.0
Выпущена 11 января 2019 г.
Первая регистрируемая версия документа.

Версия 2.1
Выпущена 10 апреля 2019 г.
Исправлены ошибки в тексте и в ответах получаемые при выполнении запросов.

Версия 2.2
Выпущена 24 апреля 2020 г.
Изменен адрес сервера, на который необходимо отправлять API-запросы.